SecretsManagerService overview
Added in v1.0.0
Table of contents
constructors
makeSecretsManagerService
Signature
export declare const makeSecretsManagerService: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
SecretsManagerService (class)
Signature
export declare class SecretsManagerService
Added in v1.0.0
SecretsManagerService$ (interface)
Signature
export interface SecretsManagerService$ {
/**
* @see {@link BatchGetSecretValueCommand}
*/
batchGetSecretValue(
args: BatchGetSecretValueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
BatchGetSecretValueCommandOutput,
| Cause.TimeoutError
| SdkError
| DecryptionError
| InternalServiceError
| InvalidNextTokenError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
batchGetSecretValueStream(
args: BatchGetSecretValueCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
BatchGetSecretValueCommandOutput,
| Cause.TimeoutError
| SdkError
| DecryptionError
| InternalServiceError
| InvalidNextTokenError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link CancelRotateSecretCommand}
*/
cancelRotateSecret(
args: CancelRotateSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CancelRotateSecretCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link CreateSecretCommand}
*/
createSecret(
args: CreateSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateSecretCommandOutput,
| Cause.TimeoutError
| SdkError
| DecryptionError
| EncryptionError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| LimitExceededError
| MalformedPolicyDocumentError
| PreconditionNotMetError
| ResourceExistsError
| ResourceNotFoundError
>
/**
* @see {@link DeleteResourcePolicyCommand}
*/
deleteResourcePolicy(
args: DeleteResourcePolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteResourcePolicyCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link DeleteSecretCommand}
*/
deleteSecret(
args: DeleteSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteSecretCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link DescribeSecretCommand}
*/
describeSecret(
args: DescribeSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeSecretCommandOutput,
Cause.TimeoutError | SdkError | InternalServiceError | InvalidParameterError | ResourceNotFoundError
>
/**
* @see {@link GetRandomPasswordCommand}
*/
getRandomPassword(
args: GetRandomPasswordCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetRandomPasswordCommandOutput,
Cause.TimeoutError | SdkError | InternalServiceError | InvalidParameterError | InvalidRequestError
>
/**
* @see {@link GetResourcePolicyCommand}
*/
getResourcePolicy(
args: GetResourcePolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetResourcePolicyCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link GetSecretValueCommand}
*/
getSecretValue(
args: GetSecretValueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetSecretValueCommandOutput,
| Cause.TimeoutError
| SdkError
| DecryptionError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link ListSecretVersionIdsCommand}
*/
listSecretVersionIds(
args: ListSecretVersionIdsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListSecretVersionIdsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidNextTokenError
| InvalidParameterError
| ResourceNotFoundError
>
listSecretVersionIdsStream(
args: ListSecretVersionIdsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListSecretVersionIdsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidNextTokenError
| InvalidParameterError
| ResourceNotFoundError
>
/**
* @see {@link ListSecretsCommand}
*/
listSecrets(
args: ListSecretsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListSecretsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidNextTokenError
| InvalidParameterError
| InvalidRequestError
>
listSecretsStream(
args: ListSecretsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListSecretsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidNextTokenError
| InvalidParameterError
| InvalidRequestError
>
/**
* @see {@link PutResourcePolicyCommand}
*/
putResourcePolicy(
args: PutResourcePolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutResourcePolicyCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| MalformedPolicyDocumentError
| PublicPolicyError
| ResourceNotFoundError
>
/**
* @see {@link PutSecretValueCommand}
*/
putSecretValue(
args: PutSecretValueCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutSecretValueCommandOutput,
| Cause.TimeoutError
| SdkError
| DecryptionError
| EncryptionError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| LimitExceededError
| ResourceExistsError
| ResourceNotFoundError
>
/**
* @see {@link RemoveRegionsFromReplicationCommand}
*/
removeRegionsFromReplication(
args: RemoveRegionsFromReplicationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RemoveRegionsFromReplicationCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link ReplicateSecretToRegionsCommand}
*/
replicateSecretToRegions(
args: ReplicateSecretToRegionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ReplicateSecretToRegionsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link RestoreSecretCommand}
*/
restoreSecret(
args: RestoreSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RestoreSecretCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link RotateSecretCommand}
*/
rotateSecret(
args: RotateSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RotateSecretCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link StopReplicationToReplicaCommand}
*/
stopReplicationToReplica(
args: StopReplicationToReplicaCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
StopReplicationToReplicaCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link TagResourceCommand}
*/
tagResource(
args: TagResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
TagResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link UntagResourceCommand}
*/
untagResource(
args: UntagResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UntagResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| ResourceNotFoundError
>
/**
* @see {@link UpdateSecretCommand}
*/
updateSecret(
args: UpdateSecretCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateSecretCommandOutput,
| Cause.TimeoutError
| SdkError
| DecryptionError
| EncryptionError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| LimitExceededError
| MalformedPolicyDocumentError
| PreconditionNotMetError
| ResourceExistsError
| ResourceNotFoundError
>
/**
* @see {@link UpdateSecretVersionStageCommand}
*/
updateSecretVersionStage(
args: UpdateSecretVersionStageCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateSecretVersionStageCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| LimitExceededError
| ResourceNotFoundError
>
/**
* @see {@link ValidateResourcePolicyCommand}
*/
validateResourcePolicy(
args: ValidateResourcePolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ValidateResourcePolicyCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceError
| InvalidParameterError
| InvalidRequestError
| MalformedPolicyDocumentError
| ResourceNotFoundError
>
}
Added in v1.0.0
utils
SecretsManagerService (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<SecretsManagerClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = SecretsManagerService$
Added in v1.0.0