{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.secretsmanager#APIErrorListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#APIErrorType" } }, "com.amazonaws.secretsmanager#APIErrorType": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

" } }, "ErrorCode": { "target": "com.amazonaws.secretsmanager#ErrorCode", "traits": { "smithy.api#documentation": "

The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example\n ResourceNotFoundException,InvalidParameterException,\n InvalidRequestException, DecryptionFailure, or\n AccessDeniedException.

" } }, "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage", "traits": { "smithy.api#documentation": "

A message describing the error.

" } } }, "traits": { "smithy.api#documentation": "

The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.

" } }, "com.amazonaws.secretsmanager#AddReplicaRegionListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#ReplicaRegionType" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.secretsmanager#AssociateCrossAccountReplica": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#AssociateCrossAccountReplicaRequest" }, "output": { "target": "com.amazonaws.secretsmanager#AssociateCrossAccountReplicaResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#LimitExceededException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Links a primary secret in your account to a replica secret in a different Amazon Web Services\n account and starts replication to this replica. The replica secret must already exist in the\n other Amazon Web Services account. Create the replica with CreateSecret and set its\n CrossAccountPrimaryARN field set to this primary secret's ARN.\n When you call AssociateCrossAccountReplica, Secrets Manager calls\n AcceptCrossAccountReplication on the replica secret on your behalf.

\n

The primary and replica secrets must be in the same Amazon Web Services Region and partition, and\n you must call this operation from the account that owns the primary secret. A primary\n secret can have at most one cross-account replica. This operation is idempotent, so\n you can call it again for the same replica to repair replication. If the association fails,\n Secrets Manager does not modify either the primary or replica secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:AssociateCrossAccountReplica,\n secretsmanager:GetSecretValue on the primary secret, and\n secretsmanager:AcceptCrossAccountReplication on the replica secret. You\n must also have kms:Decrypt permission for the Key Management Service\n (KMS) key that encrypts the primary secret, and\n kms:Encrypt permission for the Amazon Web Services KMS key that encrypts the replica\n secret. If you supply ReplicationRoleARN, you also need\n iam:PassRole for that role. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To replicate a secret to another account", "documentation": "The following example links a primary secret to a replica secret in another AWS account and starts replication. The replica secret was previously created in the other account using CreateSecret with the CrossAccountPrimaryARN set to this primary secret.", "input": { "SecretId": "MyTestDatabaseSecret", "CrossAccountReplicaARN": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "CrossAccountReplicaARN": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3", "ReplicationStatus": "InProgress" } } ] } }, "com.amazonaws.secretsmanager#AssociateCrossAccountReplicaRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the primary secret in your account to replicate.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "CrossAccountReplicaARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the replica secret in the other Amazon Web Services account. The replica secret must be\n in the same Region and partition as the primary secret. Additionally, the replica account owner\n must have created the replica secret as a cross-account replica of the primary secret.\n For more information see CreateSecret.

", "smithy.api#required": {} } }, "ReplicaRestriction": { "target": "com.amazonaws.secretsmanager#ReplicaRestrictionType", "traits": { "smithy.api#documentation": "

Whether the replica account must belong to the same Amazon Web Services organization as the primary\n account:

\n " } }, "ReplicationRoleARN": { "target": "com.amazonaws.secretsmanager#RoleARNType", "traits": { "smithy.api#documentation": "

The ARN of an IAM role in the primary account that Secrets Manager assumes to perform\n replication. If you don't include this field, Secrets Manager replicates using the credentials\n of caller who updates the primary secret. For more information, see \n Cross-account replication permissions.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#AssociateCrossAccountReplicaResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the primary secret.

" } }, "CrossAccountReplicaARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the replica secret in the other account.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#StatusType", "traits": { "smithy.api#documentation": "

The status of replication to the replica secret. Possible values:

\n " } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.secretsmanager#BatchGetSecretValue": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#BatchGetSecretValueRequest" }, "output": { "target": "com.amazonaws.secretsmanager#BatchGetSecretValueResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#DecryptionFailure" }, { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary for up to 20 secrets. To retrieve a single secret, call\n GetSecretValue.

\n

To choose which secrets to retrieve, you can specify a list of secrets by name or ARN,\n or you can use filters. If Secrets Manager encounters errors such as\n AccessDeniedException while attempting to retrieve any of the secrets,\n you can see the errors in Errors in the response.

\n

Secrets Manager generates CloudTrail\n GetSecretValue log entries for each secret you request when you call this\n action. Do not include sensitive information in request parameters because it might be\n logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions: \n secretsmanager:BatchGetSecretValue, and you must have\n secretsmanager:GetSecretValue for each secret. If you use filters, you\n must also have secretsmanager:ListSecrets. If the secrets are encrypted\n using customer-managed keys instead of the Amazon Web Services managed key\n aws/secretsmanager, then you also need kms:Decrypt\n permissions for the keys. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To retrieve the secret values for a group of secrets listed by name", "documentation": "The following example gets the values for three secrets.", "input": { "SecretIdList": [ "MySecret1", "MySecret2", "MySecret3" ] }, "output": { "SecretValues": [ { "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3", "CreatedDate": 1700591229.801, "Name": "MySecret1", "SecretString": "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}", "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "VersionStages": [ "AWSCURRENT" ] }, { "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3", "CreatedDate": 1699911394.105, "Name": "MySecret2", "SecretString": "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"", "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "VersionStages": [ "AWSCURRENT" ] }, { "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3", "CreatedDate": 1699911394.105, "Name": "MySecret3", "SecretString": "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"", "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", "VersionStages": [ "AWSCURRENT" ] } ], "Errors": [] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.secretsmanager#BatchGetSecretValueRequest": { "type": "structure", "members": { "SecretIdList": { "target": "com.amazonaws.secretsmanager#SecretIdListType", "traits": { "smithy.api#documentation": "

The ARN or names of the secrets to retrieve. You must include Filters or\n SecretIdList, but not both.

" } }, "Filters": { "target": "com.amazonaws.secretsmanager#FiltersListType", "traits": { "smithy.api#documentation": "

The filters to choose which secrets to retrieve. You must include Filters\n or SecretIdList, but not both.

" } }, "MaxResults": { "target": "com.amazonaws.secretsmanager#MaxResultsBatchType", "traits": { "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call\n BatchGetSecretValue again with the value from NextToken.\n To use this parameter, you must also use the Filters parameter.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call BatchGetSecretValue\n again with this value.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#BatchGetSecretValueResponse": { "type": "structure", "members": { "SecretValues": { "target": "com.amazonaws.secretsmanager#SecretValuesType", "traits": { "smithy.api#documentation": "

A list of secret values.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. This can occur even when the response includes no values at all,\n such as when you ask for a filtered view of a long list. To get the next results, call\n BatchGetSecretValue again with this value.

" } }, "Errors": { "target": "com.amazonaws.secretsmanager#APIErrorListType", "traits": { "smithy.api#documentation": "

A list of errors Secrets Manager encountered while attempting to retrieve individual\n secrets.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#BooleanType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#CancelRotateSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#CancelRotateSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#CancelRotateSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in progress, cancels the\n rotation.

\n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. You might need to remove the staging label\n AWSPENDING from the partially created version. You also need to\n determine whether to roll back to the previous version of the secret by moving the\n staging label AWSCURRENT to the version that has AWSPENDING.\n To determine which version has a specific staging label, call DescribeSecret. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation\n works.

\n

To turn on automatic rotation again, call RotateSecret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:CancelRotateSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To cancel scheduled rotation for a secret", "documentation": "The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "Name" } } ] } }, "com.amazonaws.secretsmanager#CancelRotateSecretRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#CancelRotateSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. We\n recommend that you remove the VersionStage value AWSPENDING\n from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation\n can block you from starting future rotations.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#ClientRequestTokenType": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 64 } } }, "com.amazonaws.secretsmanager#CreateSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#CreateSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#CreateSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#DecryptionFailure" }, { "target": "com.amazonaws.secretsmanager#EncryptionFailure" }, { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#LimitExceededException" }, { "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.secretsmanager#PreconditionNotMetException" }, { "target": "com.amazonaws.secretsmanager#ResourceExistsException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates a new secret. A secret can be a password, a set of\n credentials such as a user name and password, an OAuth token, or other secret\n information that you store in an encrypted form in Secrets Manager. The secret also includes the\n connection information to access a database or other service. Secrets Manager does not encrypt\n this connection information. A secret in Secrets Manager consists of both the encrypted secret\n versions and the metadata that Secrets Manager uses to manage the secret.

\n

For secrets that use managed rotation, you need to create the\n secret through the managing service. For more information, see Secrets Manager secrets\n managed by other Amazon Web Services services.

\n

For information about creating a secret in the console, see Create a\n secret.

\n

To create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but\n not both. If you include SecretString or SecretBinary, then\n Secrets Manager creates an initial secret version and automatically attaches the staging label\n AWSCURRENT to it.

\n

For database credentials you want to rotate, for Secrets Manager to be able to rotate the\n secret, you must make sure the JSON you store in the SecretString matches\n the JSON\n structure of a database secret.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key\n aws/secretsmanager. If this key doesn't already exist in your account,\n then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account\n automatically have access to use aws/secretsmanager. Creating\n aws/secretsmanager can result in a one-time delay to complete the\n secret creation.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API,\n then you can't use aws/secretsmanager to encrypt the secret, and you must\n create and use a customer managed KMS key.

\n

To create a cross-account replica secret, include CrossAccountPrimaryARN.\n The replica must use a customer managed KMS key, and can't include\n AddReplicaRegions, Description, SecretBinary,\n SecretString, or Type.

\n

Secrets Manager generates a CloudTrail log entry when you call this action.\n Do not include sensitive information in request parameters except\n SecretBinary or SecretString because it might be logged.\n For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:CreateSecret. If you include tags in the\n secret, you also need secretsmanager:TagResource. To add replica Regions,\n you must also have secretsmanager:ReplicateSecretToRegions. To create a\n cross-account replica secret, you must also have\n secretsmanager:PutResourcePolicy permissions. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

\n

To encrypt the secret with a KMS key other than aws/secretsmanager, you\n need kms:GenerateDataKey and kms:Decrypt permission to the\n key.

\n \n

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.

\n
", "smithy.api#examples": [ { "title": "To create a basic secret", "documentation": "The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.", "input": { "Name": "MyTestDatabaseSecret", "Description": "My test database secret created with the CLI", "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}", "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" } }, { "title": "To create a cross-account replica secret", "documentation": "The following example creates a secret that receives replicated data from a primary secret in another AWS account, by setting the CrossAccountPrimaryARN parameter. After creating the replica, link it to the primary secret from the primary account with AssociateCrossAccountReplica.", "input": { "Name": "MyReplicaSecret", "KmsKeyId": "arn:aws:kms:us-west-2:222222222222:key/EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", "CrossAccountPrimaryARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3", "Name": "MyReplicaSecret" } } ] } }, "com.amazonaws.secretsmanager#CreateSecretRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { "smithy.api#documentation": "

The name of the new secret.

\n

The secret name can contain ASCII letters, numbers, and the following characters:\n /_+=.@-

\n

Do not end your secret name with a hyphen followed by six characters. If you do so,\n you risk confusion and unexpected results when searching for a secret by partial ARN.\n Secrets Manager automatically adds a hyphen and six random characters after the secret name at the\n end of the ARN.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { "smithy.api#documentation": "

If you include SecretString or SecretBinary, then Secrets Manager\n creates an initial version for the secret, and this parameter specifies the unique\n identifier for the new version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n
\n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

\n \n

This value becomes the VersionId of the new version.

", "smithy.api#idempotencyToken": {} } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { "smithy.api#documentation": "

The description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value\n in the secret. An alias is always prefixed by alias/, for example\n alias/aws/secretsmanager. For more information, see About\n aliases.

\n

To use a KMS key in a different account, use the key ARN or the alias ARN.

\n

If you don't specify this value, then Secrets Manager uses the key\n aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates\n it for you automatically the first time it encrypts the secret value.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API,\n then you can't use aws/secretsmanager to encrypt the secret, and you must\n create and use a customer managed KMS key.

" } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { "smithy.api#documentation": "

The binary data to encrypt and store in the new version of the secret. We recommend\n that you store your binary data in a file and then pass the contents of the file as a\n parameter.

\n

Either SecretString or SecretBinary must have a value, but\n not both.

\n

This parameter is not available in the Secrets Manager console.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { "smithy.api#documentation": "

The text data to encrypt and store in this new version of the secret. We recommend you\n use a JSON structure of key/value pairs for your secret value.

\n

Either SecretString or SecretBinary must have a value, but\n not both.

\n

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret\n text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that a Lambda rotation function can\n parse.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { "smithy.api#documentation": "

A list of tags to attach to the secret. Each tag is a key and value pair of strings in\n a JSON text string, for example:

\n

\n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n

\n

Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".

\n

If you check tags in permissions policies as part of your security strategy, then\n adding or removing a tag can change permissions. If the completion of this operation\n would result in you losing your permissions for this secret, then Secrets Manager blocks the\n operation and returns an Access Denied error. For more information, see\n Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.

\n

For information about how to format a JSON parameter for the various command line tool\n environments, see Using JSON for\n Parameters. If your command-line tool or SDK requires quotation marks around\n the parameter, you should use single quotes to avoid confusion with the double quotes\n required in the JSON text.

\n

For tag quotas and naming restrictions, see Service quotas for\n Tagging in the Amazon Web Services General Reference guide.

" } }, "AddReplicaRegions": { "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", "traits": { "smithy.api#documentation": "

A list of Regions and KMS keys to replicate secrets.

" } }, "ForceOverwriteReplicaSecret": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to overwrite a secret with the same name in the destination Region.\n By default, secrets aren't overwritten.

" } }, "Type": { "target": "com.amazonaws.secretsmanager#MedeaTypeType", "traits": { "smithy.api#documentation": "

The exact string that identifies the partner that holds the external secret. For more\n information, see Using Secrets Manager managed external secrets.

" } }, "CrossAccountPrimaryARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of a primary secret in another Amazon Web Services account. Include this field to create a\n cross-account replica secret that receives replicated data from that primary secret. The\n primary secret must be in the same Amazon Web Services Region and partition as the replica, and you must\n specify a customer managed KMS key in KmsKeyId. You can't include\n SecretString, SecretBinary, Description,\n AddReplicaRegions, or Type.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#CreateSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the new secret. The ARN includes the name of the secret followed by six\n random characters. This ensures that if you create a new secret with the same name as a\n deleted secret, then users with access to the old secret don't get access to the new\n secret because the ARNs are different.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the new secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique identifier associated with the version of the new secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { "smithy.api#documentation": "

A list of the replicas of this secret and their status:

\n " } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#CreatedDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#CrossAccountPrimaryType": { "type": "structure", "members": { "PrimarySecretARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the primary secret replicating into this replica secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#StatusType", "traits": { "smithy.api#documentation": "

The status of replication from the primary secret to this replica. The status can be:

\n " } }, "StatusMessage": { "target": "com.amazonaws.secretsmanager#StatusMessageType", "traits": { "smithy.api#documentation": "

A message that describes the replication status, if Secrets Manager has more information to\n provide.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the primary secret that a cross-account replica secret\n replicates from, including its ARN and replication status. This information is only\n available for cross-account replica secrets.

" } }, "com.amazonaws.secretsmanager#CrossAccountReplicaEntry": { "type": "structure", "members": { "ReplicaSecretARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the replica secret.

" } }, "ReplicationRoleARN": { "target": "com.amazonaws.secretsmanager#RoleARNType", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that Secrets Manager assumes to replicate to this replica, if one was\n specified when the replica was associated.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#StatusType", "traits": { "smithy.api#documentation": "

The status of replication from this primary secret. The status can be:

\n " } }, "StatusMessage": { "target": "com.amazonaws.secretsmanager#StatusMessageType", "traits": { "smithy.api#documentation": "

A message that describes the replication status, if Secrets Manager has more information to\n provide.

" } } }, "traits": { "smithy.api#documentation": "

Information about a cross-account replica secret. This information is only\n available for cross-account primary secrets.

" } }, "com.amazonaws.secretsmanager#CrossAccountReplicaListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#CrossAccountReplicaEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.secretsmanager#DecryptionFailure": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Secrets Manager can't decrypt the protected secret text using the provided KMS key.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.secretsmanager#DeleteResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a\n policy to a secret, use PutResourcePolicy.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DeleteResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To delete the resource-based policy attached to a secret", "documentation": "The following example shows how to delete the resource-based policy that is attached to a secret.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "PolicyName": "default" } } ] } }, "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to delete the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the resource policy to delete. If you don't specify this field, Secrets Manager uses\n default. You can only delete the default policy; if you\n specify any other name, the operation returns an\n InvalidParameterException.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#DeleteResourcePolicyResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret that the resource-based policy was deleted for.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { "smithy.api#documentation": "

The name of the secret that the resource-based policy was deleted for.

" } }, "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the deleted resource policy. If you didn't specify PolicyName in the\n request, this is default.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#DeleteSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#DeleteSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#DeleteSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery window during\n which you can restore the secret. The minimum recovery window is 7 days. The default\n recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the\n secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

You can't delete a primary secret that is replicated to other Regions. You must first\n delete the replicas using RemoveRegionsFromReplication, and then\n delete the primary secret. When you delete a replica, it is deleted immediately.

\n

You can't delete a cross-account primary secret that is associated with a\n cross-account replica secret. You must first disassociate each of the replicas using\n DisassociateCrossAccountReplica, before deleting the primary secret.\n Similarly, you can't delete a cross-account replica secret without first stopping\n replication. Call StopReplicationToReplica to stop replication, and\n then you can delete the secret.

\n

You can't directly delete a version of a secret. Instead, you remove all staging\n labels from the version using UpdateSecretVersionStage. This marks the\n version as deprecated, and then Secrets Manager can automatically delete the version in the\n background.

\n

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm\n to alert you to any attempts to access a secret during the recovery window. For more\n information, see \n Monitor secrets scheduled for deletion.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret\n to remove the DeletionDate and cancel the deletion of the secret.

\n

When a secret is scheduled for deletion, you cannot retrieve the secret value. You\n must first cancel the deletion with RestoreSecret and then you can\n retrieve the secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DeleteSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DeleteSecretRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to delete.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "RecoveryWindowInDays": { "target": "com.amazonaws.secretsmanager#RecoveryWindowInDaysType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the\n secret. You can't use both this parameter and ForceDeleteWithoutRecovery in\n the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery\n window.

" } }, "ForceDeleteWithoutRecovery": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to delete the secret without any recovery window. You can't use both\n this parameter and RecoveryWindowInDays in the same call. If you don't use\n either, then by default Secrets Manager uses a 30 day recovery window.

\n

Secrets Manager performs the actual deletion with an asynchronous background process, so there\n might be a short delay before the secret is permanently deleted. If you delete a secret\n and then immediately create a secret with the same name, use appropriate back off and\n retry logic.

\n

If you forcibly delete an already deleted or nonexistent secret, the operation does\n not return ResourceNotFoundException.

\n \n

Use this parameter with caution. This parameter causes the operation to skip the\n normal recovery window before the permanent deletion that Secrets Manager would normally\n impose with the RecoveryWindowInDays parameter. If you delete a secret\n with the ForceDeleteWithoutRecovery parameter, then you have no\n opportunity to recover the secret. You lose the secret permanently.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#DeleteSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } }, "DeletionDate": { "target": "com.amazonaws.secretsmanager#DeletionDateType", "traits": { "smithy.api#documentation": "

The date and time after which this secret Secrets Manager can permanently delete this secret,\n and it can no longer be restored. This value is the date and time of the delete request\n plus the number of days in RecoveryWindowInDays.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#DeletedDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#DeletionDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#DescribeSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#DescribeSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#DescribeSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the details of a secret. It does not include the encrypted secret value.\n Secrets Manager only returns fields that have a value in the response.

\n \n

The VersionIdsToStages field in the response includes every version ID\n that has a staging label attached, even if that version doesn't contain a secret\n value. In contrast, ListSecretVersionIds only returns versions that\n contain a secret value. To check whether a secret version contains a value, call\n GetSecretValue.

\n
\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DescribeSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.test#smokeTests": [ { "id": "DescribeSecretFailure", "params": { "SecretId": "fake-secret-id" }, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "failure": {} } } ] } }, "com.amazonaws.secretsmanager#DescribeSecretRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#DescribeSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } }, "Type": { "target": "com.amazonaws.secretsmanager#MedeaTypeType", "traits": { "smithy.api#documentation": "

The exact string that identifies the partner that holds the external secret. For more\n information, see Using Secrets Manager managed external secrets.

" } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { "smithy.api#documentation": "

The description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { "smithy.api#documentation": "

The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.\n If the secret is encrypted with the Amazon Web Services managed key\n aws/secretsmanager, this field is omitted. Secrets created using the\n console use an KMS key ID.

" } }, "RotationEnabled": { "target": "com.amazonaws.secretsmanager#RotationEnabledType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether automatic rotation is turned on for this secret. If the secret has\n never been configured for rotation, Secrets Manager returns null.

\n

To turn on rotation, use RotateSecret. To turn off rotation, use\n CancelRotateSecret.

" } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { "smithy.api#documentation": "

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

" } }, "RotationRules": { "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { "smithy.api#documentation": "

The rotation schedule and Lambda function for this secret. If the secret previously had\n rotation turned on, but it is now turned off, this field shows the previous rotation\n schedule and rotation function. If the secret never had rotation turned on, this field\n is omitted.

" } }, "ExternalSecretRotationMetadata": { "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType", "traits": { "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information about the\n required information, see Managed external secrets partners.

" } }, "ExternalSecretRotationRoleArn": { "target": "com.amazonaws.secretsmanager#RoleARNType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held\n by a third-party partner. For more information, see Security and\n permissions.

" } }, "LastRotatedDate": { "target": "com.amazonaws.secretsmanager#LastRotatedDateType", "traits": { "smithy.api#documentation": "

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured\n for rotation or rotation has been disabled, Secrets Manager returns null.

" } }, "LastChangedDate": { "target": "com.amazonaws.secretsmanager#LastChangedDateType", "traits": { "smithy.api#documentation": "

The last date and time that this secret was modified in any way.

" } }, "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the\n secret has never been retrieved in the Region.

" } }, "DeletedDate": { "target": "com.amazonaws.secretsmanager#DeletedDateType", "traits": { "smithy.api#documentation": "

The date the secret is scheduled for deletion. If it is not scheduled for deletion,\n this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at\n least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes\n the secret, including all of its versions.

\n

If a secret is scheduled for deletion, then its details, including the encrypted\n secret value, is not accessible. To cancel a scheduled deletion and restore access to\n the secret, use RestoreSecret.

" } }, "NextRotationDate": { "target": "com.amazonaws.secretsmanager#NextRotationDateType", "traits": { "smithy.api#documentation": "

The next rotation is scheduled to occur on or before this date. If the secret isn't\n configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation\n fails, Secrets Manager retries the entire rotation process multiple times. If rotation\n is unsuccessful, this date may be in the past.

\n

This date represents the latest date that rotation will occur, but it is not an\n approximate rotation date. In some cases, for example if you turn off automatic rotation\n and then turn it back on, the next rotation may occur much sooner than this date.

" } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { "smithy.api#documentation": "

The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

" } }, "VersionIdsToStages": { "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", "traits": { "smithy.api#documentation": "

A list of the versions of the secret that have staging labels attached. Versions that\n don't have staging labels are considered deprecated and Secrets Manager can delete them.

\n

Secrets Manager uses staging labels to indicate the status of a secret version during rotation.\n The three staging labels for rotation are:

\n \n

For more information about rotation and staging labels, see How rotation works.

" } }, "OwningService": { "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { "smithy.api#documentation": "

The ID of the service that created this secret. For more information, see Secrets managed by\n other Amazon Web Services services.

" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#TimestampType", "traits": { "smithy.api#documentation": "

The date the secret was created.

" } }, "PrimaryRegion": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { "smithy.api#documentation": "

The Region the secret is in. If a secret is replicated to other Regions, the replicas\n are listed in ReplicationStatus.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { "smithy.api#documentation": "

A list of the replicas of this secret and their status:

\n " } }, "CrossAccountPrimary": { "target": "com.amazonaws.secretsmanager#CrossAccountPrimaryType", "traits": { "smithy.api#documentation": "

Information about the primary secret in the other Amazon Web Services account that this\n cross-account replica secret replicates from, including the primary secret ARN and the\n replication status. This field is omitted if the secret is not a cross-account\n replica.

" } }, "CrossAccountReplicas": { "target": "com.amazonaws.secretsmanager#CrossAccountReplicaListType", "traits": { "smithy.api#documentation": "

A list of this secret's cross-account replica secrets and their replication status, if\n this secret is the primary for cross-account replication. This field is omitted if the\n secret has no cross-account replicas.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#DescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.secretsmanager#DisassociateCrossAccountReplica": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#DisassociateCrossAccountReplicaRequest" }, "output": { "target": "com.amazonaws.secretsmanager#DisassociateCrossAccountReplicaResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes the link between a primary secret in your account and a cross-account replica\n secret, and stops replication to the replica secret. Call this operation on the primary secret.\n This action removes the replica association created by AssociateCrossAccountReplica.

\n

Disassociating the replica from the primary does not delete the replica secret or\n convert the replica secret to a standalone secret. The replica secret remains in the other\n account and its replication status changes to Detached. Secrets Manager no longer sends updates\n from the primary secret to the replica secret after disassociation. To convert a detached\n replica into a standalone secret, call\n StopReplicationToReplica on the replica secret.

\n

You must disassociate a cross-account replica before you call DeleteSecret for the primary secret. The DeleteSecret\n call fails if any replicas are still associated with the primary secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DisassociateCrossAccountReplica.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To stop replicating a secret to another account from the primary account", "documentation": "The following example, called from the primary account, removes the link between a primary secret and its cross-account replica and stops replication. The replica secret remains in the other account, now with a replication status of Detached.", "input": { "SecretId": "MyTestDatabaseSecret", "CrossAccountReplicaARN": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "CrossAccountReplicaARN": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3" } } ] } }, "com.amazonaws.secretsmanager#DisassociateCrossAccountReplicaRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the primary secret in your account.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "CrossAccountReplicaARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the cross-account replica secret to unlink from the primary secret.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#DisassociateCrossAccountReplicaResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the primary secret.

" } }, "CrossAccountReplicaARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the replica secret that was unlinked from the primary secret.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#DurationType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 3 }, "smithy.api#pattern": "^[0-9]+h$" } }, "com.amazonaws.secretsmanager#EncryptionFailure": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the\n KMS key is available, enabled, and not in an invalid state. For more\n information, see Key state: Effect on your KMS key.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#ErrorCode": { "type": "string" }, "com.amazonaws.secretsmanager#ErrorMessage": { "type": "string" }, "com.amazonaws.secretsmanager#ExcludeCharactersType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.secretsmanager#ExcludeLowercaseType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#ExcludeNumbersType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#ExcludePunctuationType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#ExcludeUppercaseType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItem": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemKeyType", "traits": { "smithy.api#documentation": "

The key that identifies the item.

" } }, "Value": { "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemValueType", "traits": { "smithy.api#documentation": "

The value of the specified item.

" } } }, "traits": { "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information, see Managed\n external secret partners.

" } }, "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItem" } }, "com.amazonaws.secretsmanager#Filter": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.secretsmanager#FilterNameStringType", "traits": { "smithy.api#documentation": "

The following are keys you can use:

\n " } }, "Values": { "target": "com.amazonaws.secretsmanager#FilterValuesStringList", "traits": { "smithy.api#documentation": "

The keyword to filter for.

\n

You can prefix your search value with an exclamation mark (!) in order to\n perform negation filters.

" } } }, "traits": { "smithy.api#documentation": "

Allows you to add filters when you use the search function in Secrets Manager. For more\n information, see Find secrets in\n Secrets Manager.

" } }, "com.amazonaws.secretsmanager#FilterNameStringType": { "type": "enum", "members": { "description": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "description" } }, "name": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "name" } }, "tag_key": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "tag-key" } }, "tag_value": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "tag-value" } }, "primary_region": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "primary-region" } }, "owning_service": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "owning-service" } }, "all": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "all" } } } }, "com.amazonaws.secretsmanager#FilterValueStringType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^\\!?[a-zA-Z0-9 :_@\\/\\+\\=\\.\\-\\!]*$" } }, "com.amazonaws.secretsmanager#FilterValuesStringList": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#FilterValueStringType" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.secretsmanager#FiltersListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#Filter" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.secretsmanager#GetRandomPassword": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#GetRandomPasswordRequest" }, "output": { "target": "com.amazonaws.secretsmanager#GetRandomPasswordResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "

Generates a random password. We recommend that you specify the maximum length and\n include every character type that the system you are generating a password for can\n support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the\n following characters in passwords:\n !\\\"#$%&'()*+,-./:;<=>?@[\\\\]^_`{|}~\n

\n

Secrets Manager generates a CloudTrail log entry when you call this\n action.

\n

\n Required permissions:\n \n secretsmanager:GetRandomPassword. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To generate a random password", "documentation": "The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.", "input": { "PasswordLength": 20, "IncludeSpace": true, "RequireEachIncludedType": true }, "output": { "RandomPassword": "EXAMPLE-PASSWORD" } } ] } }, "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { "type": "structure", "members": { "PasswordLength": { "target": "com.amazonaws.secretsmanager#PasswordLengthType", "traits": { "smithy.api#documentation": "

The length of the password. If you don't include this parameter, the default length is\n 32 characters.

" } }, "ExcludeCharacters": { "target": "com.amazonaws.secretsmanager#ExcludeCharactersType", "traits": { "smithy.api#documentation": "

A string of the characters that you don't want in the password.

" } }, "ExcludeNumbers": { "target": "com.amazonaws.secretsmanager#ExcludeNumbersType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to exclude numbers from the password. If you don't include this\n switch, the password can contain numbers.

" } }, "ExcludePunctuation": { "target": "com.amazonaws.secretsmanager#ExcludePunctuationType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to exclude the following punctuation characters from the password:\n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | }\n ~. If you don't include this switch, the password can contain\n punctuation.

" } }, "ExcludeUppercase": { "target": "com.amazonaws.secretsmanager#ExcludeUppercaseType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to exclude uppercase letters from the password. If you don't include\n this switch, the password can contain uppercase letters.

" } }, "ExcludeLowercase": { "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to exclude lowercase letters from the password. If you don't include\n this switch, the password can contain lowercase letters.

" } }, "IncludeSpace": { "target": "com.amazonaws.secretsmanager#IncludeSpaceType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to include the space character. If you include this switch, the\n password can contain space characters.

" } }, "RequireEachIncludedType": { "target": "com.amazonaws.secretsmanager#RequireEachIncludedTypeType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to include at least one upper and lowercase letter, one number, and\n one punctuation. If you don't include this switch, the password contains at least one of\n every character type.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#GetRandomPasswordResponse": { "type": "structure", "members": { "RandomPassword": { "target": "com.amazonaws.secretsmanager#RandomPasswordType", "traits": { "smithy.api#documentation": "

A string with the password.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.secretsmanager#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the secret.\n For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:GetResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To retrieve the resource-based policy attached to a secret", "documentation": "The following example shows how to retrieve the resource-based policy that is attached to a secret.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", "PolicyName": "default" } } ] } }, "com.amazonaws.secretsmanager#GetResourcePolicyRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to retrieve the attached resource-based policy\n for.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the resource policy to retrieve. If you don't specify this field, Secrets Manager\n uses default. If you specify a name other than default and no\n policy with that name exists, the operation returns a\n ResourceNotFoundException.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#GetResourcePolicyResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret that the resource-based policy was retrieved for.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { "smithy.api#documentation": "

The name of the secret that the resource-based policy was retrieved for.

" } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { "smithy.api#documentation": "

A JSON-formatted string that contains the permissions policy attached to the secret.\n For more information about permissions policies, see Authentication and access\n control for Secrets Manager.

" } }, "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the resource policy. If you didn't specify PolicyName in the\n request, this is default.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#GetSecretValue": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#GetSecretValueRequest" }, "output": { "target": "com.amazonaws.secretsmanager#GetSecretValueResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#DecryptionFailure" }, { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

To retrieve the values for a group of secrets, call BatchGetSecretValue.

\n

We recommend that you cache your secret values by using client-side caching. Caching\n secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.

\n

To retrieve the previous version of a secret, use VersionStage and\n specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:GetSecretValue. If the secret is encrypted\n using a customer-managed key instead of the Amazon Web Services managed key\n aws/secretsmanager, then you also need kms:Decrypt\n permissions for that key. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To retrieve the encrypted secret value of a secret", "documentation": "The following example shows how to retrieve a secret string value.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "CreatedDate": 1523477145.713, "Name": "MyTestDatabaseSecret", "SecretString": "{\n \"username\":\"david\",\n \"password\":\"EXAMPLE-PASSWORD\"\n}\n", "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", "VersionStages": [ "AWSPREVIOUS" ] } } ] } }, "com.amazonaws.secretsmanager#GetSecretValueRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to retrieve. To retrieve a secret from another account,\n you must use an ARN.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique identifier of the version of the secret to retrieve. If you include both\n this parameter and VersionStage, the two parameters must refer to the same\n secret version. If you don't specify either a VersionStage or\n VersionId, then Secrets Manager returns the AWSCURRENT\n version.

\n

This value is typically a UUID-type\n value with 32 hexadecimal digits.

" } }, "VersionStage": { "target": "com.amazonaws.secretsmanager#SecretVersionStageType", "traits": { "smithy.api#documentation": "

The staging label of the version of the secret to retrieve.

\n

Secrets Manager uses staging labels to keep track of different versions during the rotation\n process. If you include both this parameter and VersionId, the two\n parameters must refer to the same secret version. If you don't specify either a\n VersionStage or VersionId, Secrets Manager returns the\n AWSCURRENT version.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#GetSecretValueResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The friendly name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique identifier of this version of the secret.

" } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as binary data\n in the form of a byte array. When you retrieve a SecretBinary using the\n HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it\n is not encoded.

\n

If the secret was created by using the Secrets Manager console, or if the secret value was\n originally provided as a string, then this field is omitted. The secret value appears in\n SecretString instead.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as a string or\n through the Secrets Manager console.

\n

If this secret was created by using the console, then Secrets Manager stores the information as\n a JSON structure of key/value pairs.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { "smithy.api#documentation": "

A list of all of the staging labels currently attached to this version of the\n secret.

" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#CreatedDateType", "traits": { "smithy.api#documentation": "

The date and time that this version of the secret was created. If you don't specify\n which version in VersionId or VersionStage, then Secrets Manager uses\n the AWSCURRENT version.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#IncludeSpaceType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#InternalServiceError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

An error occurred on the server side.

", "smithy.api#error": "server" } }, "com.amazonaws.secretsmanager#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The NextToken value is invalid.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#InvalidParameterException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The parameter name or value is invalid.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

A parameter value is not valid for the current state of the\n resource.

\n

Possible causes:

\n ", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#KmsKeyIdListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType" } }, "com.amazonaws.secretsmanager#KmsKeyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.secretsmanager#LastAccessedDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#LastChangedDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#LastRotatedDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because it would exceed one of the Secrets Manager quotas.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#ListResourcePolicies": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#ListResourcePoliciesRequest" }, "output": { "target": "com.amazonaws.secretsmanager#ListResourcePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Lists the resource-based policies attached to a secret. The response contains only the\n names of the policies, not their contents. Secrets Manager lists default first,\n followed by any other policies in alphabetical order. To get the contents of a policy,\n use GetResourcePolicy. You can modify only the default\n policy.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ListResourcePolicies. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To list the resource-based policies attached to a secret", "documentation": "The following example shows how to list the resource-based policies attached to a secret.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ResourcePolicies": [ { "PolicyName": "default" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ResourcePolicies", "pageSize": "MaxResults" } } }, "com.amazonaws.secretsmanager#ListResourcePoliciesRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { "smithy.api#documentation": "

The number of results to include in the response. If you don't specify this value,\n the service returns up to 100 results.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call\n ListResourcePolicies again with the value from\n NextToken.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call\n ListResourcePolicies again with this value.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#ListResourcePoliciesResponse": { "type": "structure", "members": { "ResourcePolicies": { "target": "com.amazonaws.secretsmanager#ResourcePolicySummaryListType", "traits": { "smithy.api#documentation": "

A list of the resource policies attached to the secret.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. To get the next results, call\n ListResourcePolicies again with this value.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#ListSecretVersionIds": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#ListSecretVersionIdsRequest" }, "output": { "target": "com.amazonaws.secretsmanager#ListSecretVersionIdsResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different\n versions of a secret. For more information, see Secrets Manager\n concepts: Versions.

\n

To list the secrets in the account, use ListSecrets.

\n \n

\n ListSecretVersionIds only returns versions that contain a secret\n value. To see all version IDs that have staging labels attached, including ones\n without a secret value, call DescribeSecret and check\n VersionIdsToStages.

\n
\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ListSecretVersionIds. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To list all of the secret versions associated with a secret", "documentation": "The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.", "input": { "SecretId": "MyTestDatabaseSecret", "IncludeDeprecated": true }, "output": { "Versions": [ { "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", "VersionStages": [ "AWSPREVIOUS" ], "CreatedDate": 1523477145.713 }, { "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", "VersionStages": [ "AWSCURRENT" ], "CreatedDate": 1523486221.391 }, { "CreatedDate": 1511974462.36, "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" } ], "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.secretsmanager#ListSecretVersionIdsRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret whose versions you want to list.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call\n ListSecretVersionIds again with the value from NextToken.\n

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call ListSecretVersionIds\n again with this value.

" } }, "IncludeDeprecated": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to include versions of secrets that don't have any staging labels\n attached to them. Versions without staging labels are considered deprecated and are\n subject to deletion by Secrets Manager. By default, versions without staging labels aren't\n included.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#ListSecretVersionIdsResponse": { "type": "structure", "members": { "Versions": { "target": "com.amazonaws.secretsmanager#SecretVersionsListType", "traits": { "smithy.api#documentation": "

A list of the versions of the secret.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. This can occur even when the response includes no values at all,\n such as when you ask for a filtered view of a long list. To get the next results, call\n ListSecretVersionIds again with this value.

" } }, "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#ListSecrets": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#ListSecretsRequest" }, "output": { "target": "com.amazonaws.secretsmanager#ListSecretsResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets\n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager\n console.

\n

All Secrets Manager operations are eventually consistent. ListSecrets might not\n reflect changes from the last five minutes. You can get more recent information for a\n specific secret by calling DescribeSecret.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To retrieve the values for the secrets, call BatchGetSecretValue or\n GetSecretValue.

\n

For information about finding secrets in the console, see Find secrets in\n Secrets Manager.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ListSecrets. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To list the secrets in your account", "documentation": "The following example shows how to list all of the secrets in your account.", "output": { "SecretList": [ { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "Description": "My test database secret", "LastChangedDate": 1523477145.729, "SecretVersionsToStages": { "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ "AWSCURRENT" ] } }, { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", "Name": "MyTestDatabaseSecret1", "Description": "Another secret created for a different database", "LastChangedDate": 1523482025.685, "SecretVersionsToStages": { "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ "AWSCURRENT" ] } } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.test#smokeTests": [ { "id": "ListSecretsSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.secretsmanager#ListSecretsRequest": { "type": "structure", "members": { "IncludePlannedDeletion": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to include secrets scheduled for deletion. By default, secrets\n scheduled for deletion aren't included.

" } }, "MaxResults": { "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call ListSecrets again\n with the value from NextToken.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call ListSecrets again with\n this value.

" } }, "Filters": { "target": "com.amazonaws.secretsmanager#FiltersListType", "traits": { "smithy.api#documentation": "

The filters to apply to the list of secrets.

" } }, "SortOrder": { "target": "com.amazonaws.secretsmanager#SortOrderType", "traits": { "smithy.api#documentation": "

Secrets are listed by CreatedDate.

" } }, "SortBy": { "target": "com.amazonaws.secretsmanager#SortByType", "traits": { "smithy.api#documentation": "

If not specified, secrets are listed by CreatedDate.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#ListSecretsResponse": { "type": "structure", "members": { "SecretList": { "target": "com.amazonaws.secretsmanager#SecretListType", "traits": { "smithy.api#documentation": "

A list of the secrets in the account.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. This can occur even when the response includes no values at all,\n such as when you ask for a filtered view of a long list. To get the next results, call\n ListSecrets again with this value.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#MalformedPolicyDocumentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The resource policy has syntax errors.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#MaxResultsBatchType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 20 } } }, "com.amazonaws.secretsmanager#MaxResultsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.secretsmanager#MedeaTypeType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.secretsmanager#NameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.secretsmanager#NextRotationDateType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#NextTokenType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20480 } } }, "com.amazonaws.secretsmanager#OwningServiceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.secretsmanager#PasswordLengthType": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 4096 } } }, "com.amazonaws.secretsmanager#PreconditionNotMetException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because you did not complete all the prerequisite steps.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#PublicPolicyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.secretsmanager#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.secretsmanager#PublicPolicyException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Attaches a resource-based permission policy to a secret. A resource-based policy is\n optional. For more information, see Authentication and access control for Secrets Manager\n

\n

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:PutResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To add a resource-based policy to a secret", "documentation": "The following example shows how to add a resource-based policy to a secret.", "input": { "SecretId": "MyTestDatabaseSecret", "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "PolicyName": "default" } } ] } }, "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to attach the resource-based policy.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { "smithy.api#documentation": "

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see\n Permissions policy examples.

", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the resource policy to attach. If you don't specify this field, Secrets Manager uses\n default. You can only attach the default policy; if you\n specify any other name, the operation returns an\n InvalidParameterException.

" } }, "BlockPublicPolicy": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to block resource-based policies that allow broad access to the\n secret, for example those that use a wildcard for the principal. By default, public\n policies aren't blocked.

\n \n

Resource policy validation and the BlockPublicPolicy parameter help protect your\n resources by preventing public access from being granted through the resource\n policies that are directly attached to your secrets. In addition to using these\n features, carefully inspect the following policies to confirm that they do not grant\n public access:

\n \n

To review permissions to your secrets, see Determine who has permissions to your secrets.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#PutResourcePolicyResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } }, "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the resource policy. If you didn't specify PolicyName in the\n request, this is default.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#PutSecretValue": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#PutSecretValueRequest" }, "output": { "target": "com.amazonaws.secretsmanager#PutSecretValueResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#DecryptionFailure" }, { "target": "com.amazonaws.secretsmanager#EncryptionFailure" }, { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#LimitExceededException" }, { "target": "com.amazonaws.secretsmanager#ResourceExistsException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates a new version of your secret by creating a new encrypted value and attaching\n it to the secret. version can contain a new SecretString value or a new\n SecretBinary value.

\n

Do not call PutSecretValue at a sustained rate of more than once every 10\n minutes. When you update the secret value, Secrets Manager creates a new version of the secret.\n Secrets Manager keeps 100 of the most recent versions, but it keeps all\n secret versions created in the last 24 hours. If you call PutSecretValue\n more than once every 10 minutes, you will create more versions than Secrets Manager removes, and\n you will reach the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in\n VersionStages. If you don't include VersionStages, then\n Secrets Manager automatically moves the staging label AWSCURRENT to this version. If\n this operation creates the first version for the secret, then Secrets Manager automatically\n attaches the staging label AWSCURRENT to it. If this operation moves the\n staging label AWSCURRENT from another version to this version, then Secrets Manager\n also automatically moves the staging label AWSPREVIOUS to the version that\n AWSCURRENT was removed from.

\n

This operation is idempotent. If you call this operation with a\n ClientRequestToken that matches an existing version's VersionId, and\n you specify the same secret data, the operation succeeds but does nothing. However, if\n the secret data is different, then the operation fails because you can't modify an\n existing version; you can only create new ones.

\n

Secrets Manager generates a CloudTrail log entry when you call this action.\n Do not include sensitive information in request parameters except\n SecretBinary, SecretString, or RotationToken\n because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:PutSecretValue. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

\n \n

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.

\n
", "smithy.api#examples": [ { "title": "To store a secret value in a new version of a secret", "documentation": "The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.", "input": { "SecretId": "MyTestDatabaseSecret", "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}", "ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", "VersionStages": [ "AWSCURRENT" ] } } ] } }, "com.amazonaws.secretsmanager#PutSecretValueRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to add a new version to.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

\n

If the secret doesn't already exist, use CreateSecret instead.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { "smithy.api#documentation": "

A unique identifier for the new version of the secret.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n
\n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

\n \n

This value becomes the VersionId of the new version.

", "smithy.api#idempotencyToken": {} } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { "smithy.api#documentation": "

The binary data to encrypt and store in the new version of the secret. To use this\n parameter in the command-line tools, we recommend that you store your binary data in a\n file and then pass the contents of the file as a parameter.

\n

You must include SecretBinary or SecretString, but not\n both.

\n

You can't access this value from the Secrets Manager console.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { "smithy.api#documentation": "

The text to encrypt and store in the new version of the secret.

\n

You must include SecretBinary or SecretString, but not\n both.

\n

We recommend you create the secret string as JSON key/value pairs, as shown in the\n example.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { "smithy.api#documentation": "

A list of staging labels to attach to this version of the secret. Secrets Manager uses staging\n labels to track versions of a secret through the rotation process.

\n

If you specify a staging label that's already associated with a different version of\n the same secret, then Secrets Manager removes the label from the other version and attaches it to\n this version. If you specify AWSCURRENT, and it is already attached to\n another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the\n version that AWSCURRENT was removed from.

\n

If you don't include VersionStages, then Secrets Manager automatically moves the\n staging label AWSCURRENT to this version.

" } }, "RotationToken": { "target": "com.amazonaws.secretsmanager#RotationTokenType", "traits": { "smithy.api#documentation": "

A unique identifier that indicates the source of the request. Required for secret\n rotations using an IAM assumed role or cross-account rotation, in which you rotate a\n secret in one account by using a Lambda rotation function in another account. In both\n cases, the rotation function assumes an IAM role to call Secrets Manager, and then Secrets Manager validates\n the identity using the token. For more information, see How rotation\n works and Rotation by Lambda\n functions.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#PutSecretValueResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique identifier of the version of the secret.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { "smithy.api#documentation": "

The list of staging labels that are currently attached to this version of the secret.\n Secrets Manager uses staging labels to track a version as it progresses through the secret\n rotation process.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#RandomPasswordType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.secretsmanager#RecoveryWindowInDaysType": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.secretsmanager#RegionType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([a-z]+-)+\\d+$" } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplication": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest" }, "output": { "target": "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

For a secret that is replicated to other Regions, deletes the secret replicas from the\n Regions you specify.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:RemoveRegionsFromReplication.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

", "smithy.api#required": {} } }, "RemoveReplicaRegions": { "target": "com.amazonaws.secretsmanager#RemoveReplicaRegionListType", "traits": { "smithy.api#documentation": "

The Regions of the replicas to remove.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the primary secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { "smithy.api#documentation": "

The status of replicas for this secret after you remove Regions.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#RemoveReplicaRegionListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#RegionType" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.secretsmanager#ReplicaRegionType": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { "smithy.api#documentation": "

A Region code. For a list of Region codes, see Name and code of\n Regions.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include\n this field, Secrets Manager uses aws/secretsmanager.

" } } }, "traits": { "smithy.api#documentation": "

A custom type that specifies a Region and the KmsKeyId for a\n replica secret.

" } }, "com.amazonaws.secretsmanager#ReplicaRestrictionType": { "type": "enum", "members": { "SameOrg": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SameOrg" } }, "NoRestriction": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NoRestriction" } } } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegions": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest" }, "output": { "target": "com.amazonaws.secretsmanager#ReplicateSecretToRegionsResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ReplicateSecretToRegions. If the primary\n secret is encrypted with a KMS key other than aws/secretsmanager, you also\n need kms:Decrypt permission to the key. To encrypt the replicated secret\n with a KMS key other than aws/secretsmanager, you need\n kms:GenerateDataKey and kms:Encrypt to the key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "Example", "documentation": "The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager.", "input": { "SecretId": "MyTestSecret", "AddReplicaRegions": [ { "Region": "eu-west-3" } ], "ForceOverwriteReplicaSecret": true }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", "ReplicationStatus": [ { "Region": "eu-west-3", "KmsKeyId": "alias/aws/secretsmanager", "Status": "InProgress" } ] } } ] } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to replicate.

", "smithy.api#required": {} } }, "AddReplicaRegions": { "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", "traits": { "smithy.api#documentation": "

A list of Regions in which to replicate the secret.

", "smithy.api#required": {} } }, "ForceOverwriteReplicaSecret": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether to overwrite a secret with the same name in the destination Region.\n By default, secrets aren't overwritten.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegionsResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the primary secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { "smithy.api#documentation": "

The status of replication.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#ReplicationStatusListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#ReplicationStatusType" } }, "com.amazonaws.secretsmanager#ReplicationStatusType": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { "smithy.api#documentation": "

The Region where replication occurs.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { "smithy.api#documentation": "

Can be an ARN, Key ID, or Alias.

" } }, "Status": { "target": "com.amazonaws.secretsmanager#StatusType", "traits": { "smithy.api#documentation": "

The status can be InProgress, Failed, or\n InSync.

" } }, "StatusMessage": { "target": "com.amazonaws.secretsmanager#StatusMessageType", "traits": { "smithy.api#documentation": "

Status message such as \"Secret with this name already exists in this\n region\".

" } }, "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the\n secret has never been retrieved in the Region.

" } } }, "traits": { "smithy.api#documentation": "

A replication object consisting of a RegionReplicationStatus object and\n includes a Region, KMSKeyId, status, and status message.

" } }, "com.amazonaws.secretsmanager#RequireEachIncludedTypeType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#ResourceExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

A resource with the ID you requested already exists.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.secretsmanager#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Secrets Manager can't find the resource that you asked for.

", "smithy.api#error": "client" } }, "com.amazonaws.secretsmanager#ResourcePolicyNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[0-9A-Za-z\\-\\_]+$" } }, "com.amazonaws.secretsmanager#ResourcePolicySummary": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.secretsmanager#ResourcePolicyNameType", "traits": { "smithy.api#documentation": "

The name of the resource policy.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains details about a resource policy attached to a secret. It does\n not contain the contents of the resource policy. To view the contents of the policy, use\n GetResourcePolicy .

" } }, "com.amazonaws.secretsmanager#ResourcePolicySummaryListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#ResourcePolicySummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.secretsmanager#RestoreSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#RestoreSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#RestoreSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Cancels the scheduled deletion of a secret by removing the DeletedDate\n time stamp. You can access a secret again after it has been restored.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:RestoreSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To restore a previously deleted secret", "documentation": "The following example shows how to restore a secret that you previously scheduled for deletion.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } } ] } }, "com.amazonaws.secretsmanager#RestoreSecretRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to restore.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#RestoreSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret that was restored.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret that was restored.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#RoleARNType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.secretsmanager#RotateSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#RotateSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#RotateSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating the secret. For information\n about rotation, see Rotate secrets\n in the Secrets Manager User Guide. If you include the configuration\n parameters, the operation sets the values for the secret and then immediately starts a\n rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret.

\n

When rotation is successful, the AWSPENDING staging label might be\n attached to the same version as the AWSCURRENT version, or it might not be\n attached to any version. If the AWSPENDING staging label is present but not\n attached to the same version as AWSCURRENT, then any later invocation of\n RotateSecret assumes that a previous rotation request is still in\n progress and returns an error. When rotation is unsuccessful, the\n AWSPENDING staging label might be attached to an empty secret version.\n For more information, see Troubleshoot\n rotation in the Secrets Manager User Guide.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:RotateSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager. You also\n need lambda:InvokeFunction permissions on the rotation function. For more\n information, see Permissions for rotation.

", "smithy.api#examples": [ { "title": "To configure rotation for a secret", "documentation": "The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.", "input": { "SecretId": "MyTestDatabaseSecret", "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", "RotationRules": { "ScheduleExpression": "cron(0 16 1,15 * ? *)", "Duration": "2h" } }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" } }, { "title": "To request an immediate rotation for a secret", "documentation": "The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.", "input": { "SecretId": "MyTestDatabaseSecret" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" } } ] } }, "com.amazonaws.secretsmanager#RotateSecretRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret to rotate.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { "smithy.api#documentation": "

A unique identifier for the new version of the secret. You only need to specify this\n value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't\n attempt to create a secret version twice.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n
\n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

", "smithy.api#idempotencyToken": {} } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { "smithy.api#documentation": "

For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda\n rotation function.

\n

For secrets that use managed rotation, omit this field. For more\n information, see Managed\n rotation in the Secrets Manager User Guide.

" } }, "RotationRules": { "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { "smithy.api#documentation": "

A structure that defines the rotation configuration for this secret.

\n \n

When changing an existing rotation schedule and setting\n RotateImmediately to false:

\n \n
" } }, "ExternalSecretRotationMetadata": { "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType", "traits": { "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information about the\n required information, see Using Secrets Manager managed external secrets\n

" } }, "ExternalSecretRotationRoleArn": { "target": "com.amazonaws.secretsmanager#RoleARNType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held\n by a third-party partner. For more information, see Security and\n permissions.

" } }, "RotateImmediately": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Specifies whether to rotate the secret immediately or wait until the next scheduled\n rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

\n

The default for RotateImmediately is true. If you don't\n specify this value, Secrets Manager rotates the secret immediately.

\n

If you set RotateImmediately to false, Secrets Manager tests\n the rotation configuration by running the \n testSecret step of the Lambda rotation function. This test\n creates an AWSPENDING version of the secret and then removes it.

\n

When changing an existing rotation schedule and setting RotateImmediately\n to false:

\n \n

Rotation is an asynchronous process. For more information, see How rotation works.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#RotateSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The ID of the new version of the secret.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#RotationEnabledType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.secretsmanager#RotationLambdaARNType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.secretsmanager#RotationRulesType": { "type": "structure", "members": { "AutomaticallyAfterDays": { "target": "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType", "traits": { "smithy.api#documentation": "

The number of days between rotations of the secret. You can use this value to check\n that your secret meets your compliance guidelines for how often secrets must be rotated.\n If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation\n date based on the previous rotation. Manually updating the secret value by calling\n PutSecretValue or UpdateSecret is considered a valid\n rotation.

\n

In DescribeSecret and ListSecrets, this value is calculated\n from the rotation schedule after every successful rotation. In\n RotateSecret, you can set the rotation schedule in\n RotationRules with AutomaticallyAfterDays or\n ScheduleExpression, but not both. To set a rotation schedule in hours,\n use ScheduleExpression.

" } }, "Duration": { "target": "com.amazonaws.secretsmanager#DurationType", "traits": { "smithy.api#documentation": "

The length of the rotation window in hours, for example 3h for a three\n hour window. Secrets Manager rotates your secret at any time during this window. The window must\n not extend into the next rotation window or the next UTC day. The window starts\n according to the ScheduleExpression. If you don't specify a\n Duration, for a ScheduleExpression in hours, the window\n automatically closes after one hour. For a ScheduleExpression in days, the\n window automatically closes at the end of the UTC day. For more information, including\n examples, see Schedule\n expressions in Secrets Manager rotation in the Secrets Manager Users\n Guide.

" } }, "ScheduleExpression": { "target": "com.amazonaws.secretsmanager#ScheduleExpressionType", "traits": { "smithy.api#documentation": "

A cron() or rate() expression that defines the schedule for\n rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your\n secret any time during a rotation window.

\n

Secrets Manager rate() expressions represent the interval in hours or days that you\n want to rotate your secret, for example rate(12 hours) or rate(10\n days). You can rotate a secret as often as every four hours. If you use a\n rate() expression, the rotation window starts at midnight. For a rate\n in hours, the default rotation window closes after one hour. For a rate in days, the\n default rotation window closes at the end of the day. You can set the\n Duration to change the rotation window. The rotation window must not\n extend into the next UTC day or into the next rotation window.

\n

You can use a cron() expression to create a rotation schedule that is\n more detailed than a rotation interval. For more information, including examples, see\n Schedule\n expressions in Secrets Manager rotation in the Secrets Manager Users Guide.\n For a cron expression that represents a schedule in hours, the default rotation window\n closes after one hour. For a cron expression that represents a schedule in days, the\n default rotation window closes at the end of the day. You can set the\n Duration to change the rotation window. The rotation window must not\n extend into the next UTC day or into the next rotation window.

" } } }, "traits": { "smithy.api#documentation": "

A structure that defines the rotation configuration for the secret.

" } }, "com.amazonaws.secretsmanager#RotationTokenType": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.secretsmanager#ScheduleExpressionType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[0-9A-Za-z\\(\\)#\\?\\*\\-\\/, ]+$" } }, "com.amazonaws.secretsmanager#SecretARNType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.secretsmanager#SecretBinaryType": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 65536 }, "smithy.api#sensitive": {} } }, "com.amazonaws.secretsmanager#SecretIdListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#SecretIdType" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.secretsmanager#SecretIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.secretsmanager#SecretListEntry": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The friendly name of the secret.

" } }, "Type": { "target": "com.amazonaws.secretsmanager#MedeaTypeType", "traits": { "smithy.api#documentation": "

The exact string that identifies the third-party partner that holds the external\n secret. For more information, see Managed external secret\n partners.

" } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { "smithy.api#documentation": "

The user-provided description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { "smithy.api#documentation": "

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is\n encrypted with the Amazon Web Services managed key aws/secretsmanager, this\n field is omitted.

" } }, "RotationEnabled": { "target": "com.amazonaws.secretsmanager#RotationEnabledType", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Indicates whether automatic, scheduled rotation is enabled for this secret.

" } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { "smithy.api#documentation": "

The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret\n either automatically per the schedule or manually by a call to \n RotateSecret\n .

" } }, "RotationRules": { "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { "smithy.api#documentation": "

A structure that defines the rotation configuration for the secret.

" } }, "ExternalSecretRotationMetadata": { "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType", "traits": { "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information about the\n required information, see Managed external secrets partners.

" } }, "ExternalSecretRotationRoleArn": { "target": "com.amazonaws.secretsmanager#RoleARNType", "traits": { "smithy.api#documentation": "

The role that Secrets Manager assumes to call APIs required to perform the rotation. For more\n information about the required information, see Managed\n external secrets partners.

" } }, "LastRotatedDate": { "target": "com.amazonaws.secretsmanager#LastRotatedDateType", "traits": { "smithy.api#documentation": "

The most recent date and time that the Secrets Manager rotation process was\n successfully completed. This value is null if the secret hasn't ever rotated.

" } }, "LastChangedDate": { "target": "com.amazonaws.secretsmanager#LastChangedDateType", "traits": { "smithy.api#documentation": "

The last date and time that this secret was modified in any way.

" } }, "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the\n secret has never been retrieved in the Region.

" } }, "DeletedDate": { "target": "com.amazonaws.secretsmanager#DeletedDateType", "traits": { "smithy.api#documentation": "

The date and time the deletion of the secret occurred. Not present on active secrets.\n The secret can be recovered until the number of days in the recovery window has passed,\n as specified in the RecoveryWindowInDays parameter of the \n DeleteSecret\n operation.

" } }, "NextRotationDate": { "target": "com.amazonaws.secretsmanager#NextRotationDateType", "traits": { "smithy.api#documentation": "

The next rotation is scheduled to occur on or before this date. If the secret isn't\n configured for rotation or rotation has been disabled, Secrets Manager returns null.

" } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { "smithy.api#documentation": "

The list of user-defined tags associated with the secret. To add tags to a secret, use\n \n TagResource\n . To remove tags, use \n UntagResource\n .

" } }, "SecretVersionsToStages": { "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", "traits": { "smithy.api#documentation": "

A list of all of the currently assigned SecretVersionStage staging labels\n and the SecretVersionId attached to each one. Staging labels are used to\n keep track of the different versions during the rotation process.

\n \n

A version that does not have any SecretVersionStage is considered\n deprecated and subject to deletion. Such versions are not included in this\n list.

\n
" } }, "OwningService": { "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { "smithy.api#documentation": "

Returns the name of the service that created the secret.

" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#TimestampType", "traits": { "smithy.api#documentation": "

The date and time when a secret was created.

" } }, "PrimaryRegion": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { "smithy.api#documentation": "

The Region where Secrets Manager originated the secret.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains the details about a secret. It does not include the\n encrypted SecretString and SecretBinary values. To get those\n values, use GetSecretValue .

" } }, "com.amazonaws.secretsmanager#SecretListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#SecretListEntry" } }, "com.amazonaws.secretsmanager#SecretNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.secretsmanager#SecretStringType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65536 }, "smithy.api#sensitive": {} } }, "com.amazonaws.secretsmanager#SecretValueEntry": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The friendly name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique version identifier of this version of the secret.

" } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as binary data\n in the form of a byte array. The parameter represents the binary data as a base64-encoded\n string.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as a string or\n through the Secrets Manager console.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { "smithy.api#documentation": "

A list of all of the staging labels currently attached to this version of the\n secret.

" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#CreatedDateType", "traits": { "smithy.api#documentation": "

The date the secret was created.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains the secret value and other details for a secret.

" } }, "com.amazonaws.secretsmanager#SecretValuesType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#SecretValueEntry" } }, "com.amazonaws.secretsmanager#SecretVersionIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 32, "max": 64 } } }, "com.amazonaws.secretsmanager#SecretVersionStageType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.secretsmanager#SecretVersionStagesType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#SecretVersionStageType" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.secretsmanager#SecretVersionsListEntry": { "type": "structure", "members": { "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The unique version identifier of this version of the secret.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { "smithy.api#documentation": "

An array of staging labels that are currently associated with this version of the\n secret.

" } }, "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { "smithy.api#documentation": "

The date that this version of the secret was last accessed. Note that the resolution\n of this field is at the date level and does not include the time.

" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#CreatedDateType", "traits": { "smithy.api#documentation": "

The date and time this version of the secret was created.

" } }, "KmsKeyIds": { "target": "com.amazonaws.secretsmanager#KmsKeyIdListType", "traits": { "smithy.api#documentation": "

The KMS keys used to encrypt the secret version.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about one version of a secret.

" } }, "com.amazonaws.secretsmanager#SecretVersionsListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#SecretVersionsListEntry" } }, "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType": { "type": "map", "key": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType" }, "value": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType" } }, "com.amazonaws.secretsmanager#SortByType": { "type": "enum", "members": { "created_date": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "created-date" } }, "last_accessed_date": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "last-accessed-date" } }, "last_changed_date": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "last-changed-date" } }, "name": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "name" } } } }, "com.amazonaws.secretsmanager#SortOrderType": { "type": "enum", "members": { "asc": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "asc" } }, "desc": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "desc" } } } }, "com.amazonaws.secretsmanager#StatusMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.secretsmanager#StatusType": { "type": "enum", "members": { "InSync": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InSync" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "InProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "Detached": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Detached" } } } }, "com.amazonaws.secretsmanager#StopReplicationToReplica": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest" }, "output": { "target": "com.amazonaws.secretsmanager#StopReplicationToReplicaResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes the link between a replica secret and its primary secret, and stops\n replication to the replica. You call this operation from the replica account or Region.\n Depending on the type of replica, the behavior is:

\n \n

To stop cross-account replication from the primary account instead, use DisassociateCrossAccountReplica.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:StopReplicationToReplica. For cross-account\n replica secrets, you must also have secretsmanager:DeleteResourcePolicy\n permissions. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To stop cross-account replication from the replica account", "documentation": "The following example, called from the replica account, unlinks a cross-account replica secret from its primary secret in another account and stops replication. The secret remains in the replica account as a standalone secret.", "input": { "SecretId": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:222222222222:secret:MyReplicaSecret-a1b2c3" } } ] } }, "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the replica secret.

\n

For a cross-region replica, the replica ARN is the same as the original primary secret\n ARN except that the Region is changed to the replica Region. For a cross-account\n replica, this is the ARN or name of the replica secret in your account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#StopReplicationToReplicaResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the promoted secret. For a cross-region replica, this ARN is the same as the\n original primary secret's ARN except that the Region is changed. For a cross-account\n replica, this is the ARN of the promoted secret in your account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.secretsmanager#TagKeyType", "traits": { "smithy.api#documentation": "

The key identifier, or name, of the tag.

" } }, "Value": { "target": "com.amazonaws.secretsmanager#TagValueType", "traits": { "smithy.api#documentation": "

The string value associated with the key of the tag.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about a tag.

" } }, "com.amazonaws.secretsmanager#TagKeyListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#TagKeyType" } }, "com.amazonaws.secretsmanager#TagKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.secretsmanager#TagListType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#Tag" } }, "com.amazonaws.secretsmanager#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of\n the secret's metadata. They are not associated with specific versions of the secret.\n This operation appends tags to the existing list of tags.

\n

For tag quotas and naming restrictions, see Service quotas for\n Tagging in the Amazon Web Services General Reference guide.

\n \n

If you use tags as part of your security strategy, then adding or removing a tag\n can change permissions. If successfully completing this operation would result in\n you losing your permissions for this secret, then the operation is blocked and\n returns an Access Denied error.

\n
\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:TagResource. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To add tags to a secret", "documentation": "The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.", "input": { "SecretId": "MyExampleSecret", "Tags": [ { "Key": "FirstTag", "Value": "SomeValue" }, { "Key": "SecondTag", "Value": "AnotherValue" } ] } } ] } }, "com.amazonaws.secretsmanager#TagResourceRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The identifier for the secret to attach tags to. You can specify either the Amazon\n Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { "smithy.api#documentation": "

The tags to attach to the secret as a JSON text string argument. Each element in the\n list consists of a Key and a Value.

\n

For storing multiple values, we recommend that you use a JSON text\n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#TagValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.secretsmanager#TimestampType": { "type": "timestamp" }, "com.amazonaws.secretsmanager#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes specific tags from a secret.

\n

This operation is idempotent. If a requested tag is not attached to the secret, no\n error is returned and the secret metadata is unchanged.

\n \n

If you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an\n Access Denied error.

\n
\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:UntagResource. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To remove tags from a secret", "documentation": "The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.", "input": { "SecretId": "MyTestDatabaseSecret", "TagKeys": [ "FirstTag", "SecondTag" ] } } ] } }, "com.amazonaws.secretsmanager#UntagResourceRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.secretsmanager#TagKeyListType", "traits": { "smithy.api#documentation": "

A list of tag key names to remove from the secret. You don't specify the value. Both\n the key and its associated value are removed.

\n

This parameter requires a JSON text string argument.

\n

For storing multiple values, we recommend that you use a JSON text\n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#UpdateSecret": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#UpdateSecretRequest" }, "output": { "target": "com.amazonaws.secretsmanager#UpdateSecretResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#DecryptionFailure" }, { "target": "com.amazonaws.secretsmanager#EncryptionFailure" }, { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#LimitExceededException" }, { "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.secretsmanager#PreconditionNotMetException" }, { "target": "com.amazonaws.secretsmanager#ResourceExistsException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change\n the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret\n instead.

\n

To change a secret so that it is managed by another service, you need to recreate the\n secret in that service. See Secrets Manager secrets\n managed by other Amazon Web Services services.

\n

We recommend you avoid calling UpdateSecret at a sustained rate of more\n than once every 10 minutes. When you call UpdateSecret to update the secret\n value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when\n there are more than 100, but it does not remove versions created less than 24 hours ago.\n If you update the secret value more than once every 10 minutes, you create more versions\n than Secrets Manager removes, and you will reach the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically moves the staging label AWSCURRENT to\n the new version. Then it attaches the label AWSPREVIOUS to the version that\n AWSCURRENT was removed from.

\n

If you call this operation with a ClientRequestToken that matches an\n existing version's VersionId, the operation results in an error. You can't\n modify an existing version, you can only create a new version. To remove a version,\n remove all staging labels from it. See UpdateSecretVersionStage.

\n

Secrets Manager generates a CloudTrail log entry when you call this action.\n Do not include sensitive information in request parameters except\n SecretBinary or SecretString because it might be logged.\n For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:UpdateSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager. If you use a\n customer managed key, you must also have kms:GenerateDataKey,\n kms:Encrypt, and kms:Decrypt permissions on the key. If\n you change the KMS key and you don't have kms:Encrypt permission to the new\n key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more\n information, see Secret encryption\n and decryption.

\n \n

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.

\n
", "smithy.api#examples": [ { "title": "To create a new version of the encrypted secret value", "documentation": "The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.", "input": { "SecretId": "MyTestDatabaseSecret", "SecretString": "{JSON STRING WITH CREDENTIALS}" }, "output": { "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret", "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" } }, { "title": "To update the description of a secret", "documentation": "The following example shows how to modify the description of a secret.", "input": { "SecretId": "MyTestDatabaseSecret", "Description": "This is a new description for the secret.", "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } }, { "title": "To update the KMS key associated with a secret", "documentation": "This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.", "input": { "SecretId": "MyTestDatabaseSecret", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } } ] } }, "com.amazonaws.secretsmanager#UpdateSecretRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { "smithy.api#documentation": "

If you include SecretString or SecretBinary, then Secrets Manager\n creates a new version for the secret, and this parameter specifies the unique identifier\n for the new version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n
\n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

", "smithy.api#idempotencyToken": {} } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { "smithy.api#documentation": "

The description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new\n secret versions as well as any existing versions with the staging labels\n AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If\n you don't have kms:Encrypt permission to the new key, Secrets Manager does not\n re-encrypt existing secret versions with the new key. For more information about\n versions and staging labels, see Concepts:\n Version.

\n

A key alias is always prefixed by alias/, for example\n alias/aws/secretsmanager. For more information, see About\n aliases.

\n

If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key\n aws/secretsmanager. If this key doesn't already exist in your account,\n then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account\n automatically have access to use aws/secretsmanager. Creating\n aws/secretsmanager can result in a one-time significant delay in\n returning the result.

\n \n

You can only use the Amazon Web Services managed key\n aws/secretsmanager if you call this operation using credentials from\n the same Amazon Web Services account that owns the secret. If the secret is in a different\n account, then you must use a customer managed key and provide the ARN of that\n KMS key in this field. The user making the call must have\n permissions to both the secret and the KMS key in their respective\n accounts.

\n
" } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { "smithy.api#documentation": "

The binary data to encrypt and store in the new version of the secret. We recommend\n that you store your binary data in a file and then pass the contents of the file as a\n parameter.

\n

Either SecretBinary or SecretString must have a value, but\n not both.

\n

You can't access this parameter in the Secrets Manager console.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { "smithy.api#documentation": "

The text data to encrypt and store in the new version of the secret. We recommend you\n use a JSON structure of key/value pairs for your secret value.

\n

Either SecretBinary or SecretString must have a value, but\n not both.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" } }, "Type": { "target": "com.amazonaws.secretsmanager#MedeaTypeType", "traits": { "smithy.api#documentation": "

The exact string that identifies the third-party partner that holds the external\n secret. For more information, see Managed external secret\n partners.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#UpdateSecretResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret that was updated.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret that was updated.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

If Secrets Manager created a new version of the secret during this operation, then\n VersionId contains the unique identifier of the new version.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStage": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest" }, "output": { "target": "com.amazonaws.secretsmanager#UpdateSecretVersionStageResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#LimitExceededException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging\n labels to track a version as it progresses through the secret rotation process. Each\n staging label can be attached to only one version at a time. To add a staging label to a\n version when it is already attached to another version, Secrets Manager first removes it from the\n other version first and then attaches it to this one. For more information about\n versions and staging labels, see Concepts:\n Version.

\n

The staging labels that you specify in the VersionStage parameter are\n added to the existing list of staging labels for the version.

\n

You can move the AWSCURRENT staging label to this version by including it\n in this call.

\n \n

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label\n AWSPREVIOUS to the version that AWSCURRENT was removed\n from.

\n
\n

If this action results in the last label being removed from a version, then the\n version is considered to be 'deprecated' and can be deleted by Secrets Manager.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:UpdateSecretVersionStage. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To add a staging label attached to a version of a secret", "documentation": "The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", "input": { "SecretId": "MyTestDatabaseSecret", "VersionStage": "STAGINGLABEL1", "MoveToVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } }, { "title": "To delete a staging label attached to a version of a secret", "documentation": "The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", "input": { "SecretId": "MyTestDatabaseSecret", "VersionStage": "STAGINGLABEL1", "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } }, { "title": "To move a staging label from one version of a secret to another", "documentation": "The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", "input": { "SecretId": "MyTestDatabaseSecret", "VersionStage": "AWSCURRENT", "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", "MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" }, "output": { "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", "Name": "MyTestDatabaseSecret" } } ] } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or the name of the secret with the version and staging labelsto modify.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, "VersionStage": { "target": "com.amazonaws.secretsmanager#SecretVersionStageType", "traits": { "smithy.api#documentation": "

The staging label to add to this version.

", "smithy.api#required": {} } }, "RemoveFromVersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The ID of the version that the staging label is to be removed from. If the staging\n label you are trying to attach to one version is already attached to a different\n version, then you must include this parameter and specify the version that the label is\n to be removed from. If the label is attached and you either do not specify this\n parameter, or the version ID does not match, then the operation fails.

" } }, "MoveToVersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

The ID of the version to add the staging label to. To remove a label from a version,\n then do not specify this parameter.

\n

If the staging label is already attached to a different version of the secret, then\n you must also specify the RemoveFromVersionId parameter.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStageResponse": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

The ARN of the secret that was updated.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { "smithy.api#documentation": "

The name of the secret that was updated.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#ValidateResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest" }, "output": { "target": "com.amazonaws.secretsmanager#ValidateResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" }, { "target": "com.amazonaws.secretsmanager#InvalidRequestException" }, { "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.

\n

The API performs three checks when validating the policy:

\n \n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ValidateResourcePolicy and\n secretsmanager:PutResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", "smithy.api#examples": [ { "title": "To validate a resource-based policy to a secret", "documentation": "The following example shows how to validate a resource-based policy to a secret.", "input": { "SecretId": "MyTestDatabaseSecret", "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" }, "output": { "PolicyValidationPassed": true, "ValidationErrors": [] } } ] } }, "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": { "type": "structure", "members": { "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { "smithy.api#documentation": "

The ARN or name of the secret with the resource-based policy you want to\n validate.

" } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { "smithy.api#documentation": "

A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in\n the string identifies who can access or manage this secret and its versions. For example\n policies, see Permissions\n policy examples.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.secretsmanager#ValidateResourcePolicyResponse": { "type": "structure", "members": { "PolicyValidationPassed": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

True if your policy passes validation, otherwise false.

" } }, "ValidationErrors": { "target": "com.amazonaws.secretsmanager#ValidationErrorsType", "traits": { "smithy.api#documentation": "

Validation errors if your policy didn't pass validation.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.secretsmanager#ValidationErrorsEntry": { "type": "structure", "members": { "CheckName": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { "smithy.api#documentation": "

Checks the name of the policy.

" } }, "ErrorMessage": { "target": "com.amazonaws.secretsmanager#ErrorMessage", "traits": { "smithy.api#documentation": "

Displays error messages if validation encounters problems during validation of the\n resource policy.

" } } }, "traits": { "smithy.api#documentation": "

Displays errors that occurred during validation of the resource policy.

" } }, "com.amazonaws.secretsmanager#ValidationErrorsType": { "type": "list", "member": { "target": "com.amazonaws.secretsmanager#ValidationErrorsEntry" } }, "com.amazonaws.secretsmanager#secretsmanager": { "type": "service", "version": "2017-10-17", "operations": [ { "target": "com.amazonaws.secretsmanager#AssociateCrossAccountReplica" }, { "target": "com.amazonaws.secretsmanager#BatchGetSecretValue" }, { "target": "com.amazonaws.secretsmanager#CancelRotateSecret" }, { "target": "com.amazonaws.secretsmanager#CreateSecret" }, { "target": "com.amazonaws.secretsmanager#DeleteResourcePolicy" }, { "target": "com.amazonaws.secretsmanager#DeleteSecret" }, { "target": "com.amazonaws.secretsmanager#DescribeSecret" }, { "target": "com.amazonaws.secretsmanager#DisassociateCrossAccountReplica" }, { "target": "com.amazonaws.secretsmanager#GetRandomPassword" }, { "target": "com.amazonaws.secretsmanager#GetResourcePolicy" }, { "target": "com.amazonaws.secretsmanager#GetSecretValue" }, { "target": "com.amazonaws.secretsmanager#ListResourcePolicies" }, { "target": "com.amazonaws.secretsmanager#ListSecrets" }, { "target": "com.amazonaws.secretsmanager#ListSecretVersionIds" }, { "target": "com.amazonaws.secretsmanager#PutResourcePolicy" }, { "target": "com.amazonaws.secretsmanager#PutSecretValue" }, { "target": "com.amazonaws.secretsmanager#RemoveRegionsFromReplication" }, { "target": "com.amazonaws.secretsmanager#ReplicateSecretToRegions" }, { "target": "com.amazonaws.secretsmanager#RestoreSecret" }, { "target": "com.amazonaws.secretsmanager#RotateSecret" }, { "target": "com.amazonaws.secretsmanager#StopReplicationToReplica" }, { "target": "com.amazonaws.secretsmanager#TagResource" }, { "target": "com.amazonaws.secretsmanager#UntagResource" }, { "target": "com.amazonaws.secretsmanager#UpdateSecret" }, { "target": "com.amazonaws.secretsmanager#UpdateSecretVersionStage" }, { "target": "com.amazonaws.secretsmanager#ValidateResourcePolicy" } ], "traits": { "aws.api#service": { "sdkId": "Secrets Manager", "arnNamespace": "secretsmanager", "cloudFormationName": "SecretsManager", "cloudTrailEventSource": "secretsmanager.amazonaws.com", "docId": "secretsmanager-2017-10-17", "endpointPrefix": "secretsmanager" }, "aws.auth#sigv4": { "name": "secretsmanager" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Amazon Web Services Secrets Manager\n

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

\n

This guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.

\n

\n API Version\n

\n

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

\n

For a list of endpoints, see Amazon Web Services Secrets Manager \n endpoints.

\n

\n Support and Feedback for Amazon Web Services Secrets Manager\n

\n

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.

\n

\n Logging API Requests\n

\n

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

", "smithy.api#title": "AWS Secrets Manager", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager-fips.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager.{Region}.amazonaws.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 18, "nodes": "/////wAAAAH/////AAAAAAAAABEAAAADAAAAAQAAAAQF9eEOAAAAAgAAAAUF9eEOAAAAAwAAAAsAAAAGAAAABAAAAAcF9eENAAAABQAAAAgF9eEMAAAABwX14QkAAAAJAAAACAX14QoAAAAKAAAACQX14QkF9eELAAAABAAAAA0AAAAMAAAABgX14QcF9eEIAAAABQAAAA4F9eEGAAAABgAAAA8F9eEGAAAABwX14QQAAAAQAAAACQX14QQF9eEFAAAAAwX14QEAAAASAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://secretsmanager-fips.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://secretsmanager-fips.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://secretsmanager.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-cn", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://secretsmanager.{Region}.amazonaws.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://secretsmanager.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://secretsmanager.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://secretsmanager.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } } } }