models.kms-2014-11-01-intermediate.json Maven / Gradle / Ivy
Show all versions of kms Show documentation
{
"customizationConfig" : {
"attachPayloadTraitToMember" : { },
"blacklistedSimpleMethods" : [ ],
"calculateCrc32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customErrorCodeFieldName" : null,
"customProtocolFactoryFqcn" : null,
"customResponseMetadata" : null,
"customRetryPolicy" : null,
"customServiceMetadata" : null,
"defaultSimpleMethodTestRegion" : null,
"deprecatedOperations" : [ ],
"deprecatedShapes" : [ ],
"enableEndpointDiscoveryMethodRequired" : false,
"excludeClientCreateMethod" : false,
"modelMarshallerDefaultValueSupplier" : { },
"operationModifiers" : null,
"paginationCustomization" : null,
"renameShapes" : null,
"sdkModeledExceptionBaseClassName" : null,
"sdkRequestBaseClassName" : null,
"sdkResponseBaseClassName" : null,
"serviceSpecificClientConfigClass" : null,
"serviceSpecificHttpConfig" : null,
"shapeModifiers" : null,
"shapeSubstitutions" : null,
"shareModelConfig" : null,
"skipSyncClientGeneration" : false,
"useAutoConstructList" : true,
"useAutoConstructMap" : true,
"utilitiesMethod" : null,
"verifiedSimpleMethods" : [ "createKey", "generateRandom", "retireGrant", "describeCustomKeyStores", "listAliases", "listKeys" ]
},
"metadata" : {
"apiVersion" : "2014-11-01",
"asyncBuilder" : "DefaultKmsAsyncClientBuilder",
"asyncBuilderInterface" : "KmsAsyncClientBuilder",
"asyncClient" : "DefaultKmsAsyncClient",
"asyncInterface" : "KmsAsyncClient",
"authPolicyPackageName" : null,
"authType" : "V4",
"baseBuilder" : "DefaultKmsBaseClientBuilder",
"baseBuilderInterface" : "KmsBaseClientBuilder",
"baseExceptionName" : "KmsException",
"baseRequestName" : "KmsRequest",
"baseResponseName" : "KmsResponse",
"cborProtocol" : false,
"clientPackageName" : "kms",
"contentType" : null,
"defaultEndpoint" : null,
"defaultEndpointWithoutHttpProtocol" : null,
"defaultRegion" : null,
"descriptiveServiceName" : "KMS",
"documentation" : "AWS Key Management Service AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide .
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
-
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
-
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
-
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
",
"endpointPrefix" : "kms",
"fullAuthPolicyPackageName" : "software.amazon.awssdk.services",
"fullClientPackageName" : "software.amazon.awssdk.services.kms",
"fullModelPackageName" : "software.amazon.awssdk.services.kms.model",
"fullPaginatorsPackageName" : "software.amazon.awssdk.services.kms.paginators",
"fullRequestTransformPackageName" : "software.amazon.awssdk.services.kms.transform",
"fullTransformPackageName" : "software.amazon.awssdk.services.kms.transform",
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"modelPackageName" : "kms.model",
"paginatorsPackageName" : "kms.paginators",
"protocol" : "json",
"queryProtocol" : false,
"requestTransformPackageName" : "kms.transform",
"requiresApiKey" : false,
"requiresIamSigners" : false,
"rootPackageName" : "software.amazon.awssdk.services",
"serviceId" : "KMS",
"serviceName" : "Kms",
"signingName" : "kms",
"syncBuilder" : "DefaultKmsClientBuilder",
"syncBuilderInterface" : "KmsClientBuilder",
"syncClient" : "DefaultKmsClient",
"syncInterface" : "KmsClient",
"transformPackageName" : "kms.transform",
"uid" : "kms-2014-11-01",
"xmlProtocol" : false
},
"operations" : {
"CancelKeyDeletion" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is Disabled. To enable the CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CancelKeyDeletionRequest",
"variableName" : "cancelKeyDeletionRequest",
"variableType" : "CancelKeyDeletionRequest",
"documentation" : "",
"simpleType" : "CancelKeyDeletionRequest",
"variableSetterType" : "CancelKeyDeletionRequest"
},
"methodName" : "cancelKeyDeletion",
"operationName" : "CancelKeyDeletion",
"paginated" : false,
"returnType" : {
"returnType" : "CancelKeyDeletionResponse",
"documentation" : null
},
"syncReturnType" : "CancelKeyDeletionResponse"
},
"ConnectCustomKeyStore" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.
To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the kmsuser crypto user (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.
The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the kmsuser CU, and rotates its password.
The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.
To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again.
If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "CloudHsmClusterNotActiveException",
"documentation" : "The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreInvalidStateException",
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterInvalidConfigurationException",
"documentation" : "The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
-
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
-
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ConnectCustomKeyStoreRequest",
"variableName" : "connectCustomKeyStoreRequest",
"variableType" : "ConnectCustomKeyStoreRequest",
"documentation" : "",
"simpleType" : "ConnectCustomKeyStoreRequest",
"variableSetterType" : "ConnectCustomKeyStoreRequest"
},
"methodName" : "connectCustomKeyStore",
"operationName" : "ConnectCustomKeyStore",
"paginated" : false,
"returnType" : {
"returnType" : "ConnectCustomKeyStoreResponse",
"documentation" : null
},
"syncReturnType" : "ConnectCustomKeyStoreResponse"
},
"CreateAlias" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in cryptographic operations, such as Encrypt and GenerateDataKey. You can change the CMK associated with the alias at any time.
Aliases are easier to remember than key IDs. They can also help to simplify your applications. For example, if you use an alias in your code, you can change the CMK your code uses by associating a given alias with a different CMK.
To run the same code in multiple AWS regions, use an alias in your code, such as alias/ApplicationKey. Then, in each AWS Region, create an alias/ApplicationKey alias that is associated with a CMK in that Region. When you run your code, it uses the alias/ApplicationKey CMK for that AWS Region without any Region-specific code.
This operation does not return a response. To get the alias that you created, use the ListAliases operation.
To use aliases successfully, be aware of the following information.
-
Each alias points to only one CMK at a time, although a single CMK can have multiple aliases. The alias and its associated CMK must be in the same AWS account and Region.
-
You can associate an alias with any customer managed CMK in the same AWS account and Region. However, you do not have permission to associate an alias with an AWS managed CMK or an AWS owned CMK.
-
To change the CMK associated with an alias, use the UpdateAlias operation. The current CMK and the new CMK must be the same type (both symmetric or both asymmetric) and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents cryptographic errors in code that uses aliases.
-
The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
-
The alias name must be unique within an AWS Region. However, you can use the same alias name in multiple Regions of the same AWS account. Each instance of the alias is associated with a CMK in its Region.
-
After you create an alias, you cannot change its alias name. However, you can use the DeleteAlias operation to delete the alias and then create a new alias with the desired name.
-
You can use an alias name or alias ARN to identify a CMK in AWS KMS cryptographic operations and in the DescribeKey operation. However, you cannot use alias names or alias ARNs in API operations that manage CMKs, such as DisableKey or GetKeyPolicy. For information about the valid CMK identifiers for each AWS KMS API operation, see the descriptions of the KeyId parameter in the API operation documentation.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases and alias ARNs of CMKs in each AWS account and Region, use the ListAliases operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "AlreadyExistsException",
"documentation" : "The request was rejected because it attempted to create a resource that already exists.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidAliasNameException",
"documentation" : "The request was rejected because the specified alias name is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateAliasRequest",
"variableName" : "createAliasRequest",
"variableType" : "CreateAliasRequest",
"documentation" : "",
"simpleType" : "CreateAliasRequest",
"variableSetterType" : "CreateAliasRequest"
},
"methodName" : "createAlias",
"operationName" : "CreateAlias",
"paginated" : false,
"returnType" : {
"returnType" : "CreateAliasResponse",
"documentation" : null
},
"syncReturnType" : "CreateAliasResponse"
},
"CreateCustomKeyStore" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "CloudHsmClusterInUseException",
"documentation" : "The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNameInUseException",
"documentation" : "The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterNotActiveException",
"documentation" : "The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "IncorrectTrustAnchorException",
"documentation" : "The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.
When you initialize the cluster, you create the trust anchor certificate and save it in the customerCA.crt file.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterInvalidConfigurationException",
"documentation" : "The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
-
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
-
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateCustomKeyStoreRequest",
"variableName" : "createCustomKeyStoreRequest",
"variableType" : "CreateCustomKeyStoreRequest",
"documentation" : "",
"simpleType" : "CreateCustomKeyStoreRequest",
"variableSetterType" : "CreateCustomKeyStoreRequest"
},
"methodName" : "createCustomKeyStore",
"operationName" : "CreateCustomKeyStore",
"paginated" : false,
"returnType" : {
"returnType" : "CreateCustomKeyStoreResponse",
"documentation" : null
},
"syncReturnType" : "CreateCustomKeyStoreResponse"
},
"CreateGrant" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.
To create a grant that allows a cryptographic operation only when the request includes a particular encryption context, use the Constraints parameter. For details, see GrantConstraints.
You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support, CreateGrant fails with a ValidationException.
-
Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including Sign, Verify, and GetPublicKey. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)
-
Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that generate data keys or data key pairs, or operations related to automatic key rotation, imported key material, or CMKs in custom key stores.
-
Grants for asymmetric CMKs with a KeyUsage of ENCRYPT_DECRYPT cannot allow the Sign or Verify operations. Grants for asymmetric CMKs with a KeyUsage of SIGN_VERIFY cannot allow the Encrypt or Decrypt operations.
-
Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide .
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateGrantRequest",
"variableName" : "createGrantRequest",
"variableType" : "CreateGrantRequest",
"documentation" : "",
"simpleType" : "CreateGrantRequest",
"variableSetterType" : "CreateGrantRequest"
},
"methodName" : "createGrant",
"operationName" : "CreateGrant",
"paginated" : false,
"returnType" : {
"returnType" : "CreateGrantResponse",
"documentation" : null
},
"syncReturnType" : "CreateGrantResponse"
},
"CreateKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a unique customer managed customer master key (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.
You can use the CreateKey operation to create symmetric or asymmetric CMKs.
-
Symmetric CMKs contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
-
Asymmetric CMKs can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To create different types of CMKs, use the following guidance:
- Asymmetric CMKs
-
To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to specify the type of key material in the CMK. Then, use the KeyUsage parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.
- Symmetric CMKs
-
When creating a symmetric CMK, you don't need to specify the CustomerMasterKeySpec or KeyUsage parameters. The default value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, are the only valid values for symmetric CMKs.
- Imported Key Material
-
To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the AWS Key Management Service Developer Guide . You cannot import the key material into an asymmetric CMK.
- Custom Key Stores
-
To create a symmetric CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.
You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see Using Custom Key Stores in the AWS Key Management Service Developer Guide .
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "MalformedPolicyDocumentException",
"documentation" : "The request was rejected because the specified policy is not syntactically or semantically correct.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "TagException",
"documentation" : "The request was rejected because one or more tags are not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreInvalidStateException",
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterInvalidConfigurationException",
"documentation" : "The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
-
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
-
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateKeyRequest",
"variableName" : "createKeyRequest",
"variableType" : "CreateKeyRequest",
"documentation" : "",
"simpleType" : "CreateKeyRequest",
"variableSetterType" : "CreateKeyRequest"
},
"methodName" : "createKey",
"operationName" : "CreateKey",
"paginated" : false,
"returnType" : {
"returnType" : "CreateKeyResponse",
"documentation" : null
},
"syncReturnType" : "CreateKeyResponse"
},
"Decrypt" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:
-
-
-
-
-
You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.
If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. However, if you prefer, you can specify the KeyId to ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK than the one used to encrypt the ciphertext, the Decrypt operation fails.
Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidCiphertextException",
"documentation" : "From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
From the ImportKeyMaterial operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "IncorrectKeyException",
"documentation" : "The request was rejected because the specified CMK cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same CMK that was used to encrypt the ciphertext.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DecryptRequest",
"variableName" : "decryptRequest",
"variableType" : "DecryptRequest",
"documentation" : "",
"simpleType" : "DecryptRequest",
"variableSetterType" : "DecryptRequest"
},
"methodName" : "decrypt",
"operationName" : "Decrypt",
"paginated" : false,
"returnType" : {
"returnType" : "DecryptResponse",
"documentation" : null
},
"syncReturnType" : "DecryptResponse"
},
"DeleteAlias" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteAliasRequest",
"variableName" : "deleteAliasRequest",
"variableType" : "DeleteAliasRequest",
"documentation" : "",
"simpleType" : "DeleteAliasRequest",
"variableSetterType" : "DeleteAliasRequest"
},
"methodName" : "deleteAlias",
"operationName" : "DeleteAlias",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteAliasResponse",
"documentation" : null
},
"syncReturnType" : "DeleteAliasResponse"
},
"DeleteCustomKeyStore" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.
The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.
After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.
Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "CustomKeyStoreHasCmKsException",
"documentation" : "The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. After they are deleted, you can delete the custom key store.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreInvalidStateException",
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteCustomKeyStoreRequest",
"variableName" : "deleteCustomKeyStoreRequest",
"variableType" : "DeleteCustomKeyStoreRequest",
"documentation" : "",
"simpleType" : "DeleteCustomKeyStoreRequest",
"variableSetterType" : "DeleteCustomKeyStoreRequest"
},
"methodName" : "deleteCustomKeyStore",
"operationName" : "DeleteCustomKeyStore",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteCustomKeyStoreResponse",
"documentation" : null
},
"syncReturnType" : "DeleteCustomKeyStoreResponse"
},
"DeleteImportedKeyMaterial" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.
When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteImportedKeyMaterialRequest",
"variableName" : "deleteImportedKeyMaterialRequest",
"variableType" : "DeleteImportedKeyMaterialRequest",
"documentation" : "",
"simpleType" : "DeleteImportedKeyMaterialRequest",
"variableSetterType" : "DeleteImportedKeyMaterialRequest"
},
"methodName" : "deleteImportedKeyMaterial",
"operationName" : "DeleteImportedKeyMaterial",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteImportedKeyMaterialResponse",
"documentation" : null
},
"syncReturnType" : "DeleteImportedKeyMaterialResponse"
},
"DescribeCustomKeyStores" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both).
To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.
Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.
For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeCustomKeyStoresRequest",
"variableName" : "describeCustomKeyStoresRequest",
"variableType" : "DescribeCustomKeyStoresRequest",
"documentation" : "",
"simpleType" : "DescribeCustomKeyStoresRequest",
"variableSetterType" : "DescribeCustomKeyStoresRequest"
},
"methodName" : "describeCustomKeyStores",
"operationName" : "DescribeCustomKeyStores",
"paginated" : false,
"returnType" : {
"returnType" : "DescribeCustomKeyStoresResponse",
"documentation" : null
},
"syncReturnType" : "DescribeCustomKeyStoresResponse"
},
"DescribeKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Provides detailed information about a customer master key (CMK). You can run DescribeKey on a customer managed CMK or an AWS managed CMK.
This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.
DescribeKey does not return the following information:
-
Aliases associated with the CMK. To get this information, use ListAliases.
-
Whether automatic key rotation is enabled on the CMK. To get this information, use GetKeyRotationStatus. Also, some key states prevent a CMK from being automatically rotated. For details, see How Automatic Key Rotation Works in AWS Key Management Service Developer Guide.
-
Tags on the CMK. To get this information, use ListResourceTags.
-
Key policies and grants on the CMK. To get this information, use GetKeyPolicy and ListGrants.
If you call the DescribeKey operation on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK. Then, it associates the alias with the new CMK, and returns the KeyId and Arn of the new CMK in the response.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeKeyRequest",
"variableName" : "describeKeyRequest",
"variableType" : "DescribeKeyRequest",
"documentation" : "",
"simpleType" : "DescribeKeyRequest",
"variableSetterType" : "DescribeKeyRequest"
},
"methodName" : "describeKey",
"operationName" : "DescribeKey",
"paginated" : false,
"returnType" : {
"returnType" : "DescribeKeyResponse",
"documentation" : null
},
"syncReturnType" : "DescribeKeyResponse"
},
"DisableKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DisableKeyRequest",
"variableName" : "disableKeyRequest",
"variableType" : "DisableKeyRequest",
"documentation" : "",
"simpleType" : "DisableKeyRequest",
"variableSetterType" : "DisableKeyRequest"
},
"methodName" : "disableKey",
"operationName" : "DisableKey",
"paginated" : false,
"returnType" : {
"returnType" : "DisableKeyResponse",
"documentation" : null
},
"syncReturnType" : "DisableKeyResponse"
},
"DisableKeyRotation" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. You cannot perform this operation on a CMK in a different AWS account.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DisableKeyRotationRequest",
"variableName" : "disableKeyRotationRequest",
"variableType" : "DisableKeyRotationRequest",
"documentation" : "",
"simpleType" : "DisableKeyRotationRequest",
"variableSetterType" : "DisableKeyRotationRequest"
},
"methodName" : "disableKeyRotation",
"operationName" : "DisableKeyRotation",
"paginated" : false,
"returnType" : {
"returnType" : "DisableKeyRotationResponse",
"documentation" : null
},
"syncReturnType" : "DisableKeyRotationResponse"
},
"DisconnectCustomKeyStore" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "CustomKeyStoreInvalidStateException",
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DisconnectCustomKeyStoreRequest",
"variableName" : "disconnectCustomKeyStoreRequest",
"variableType" : "DisconnectCustomKeyStoreRequest",
"documentation" : "",
"simpleType" : "DisconnectCustomKeyStoreRequest",
"variableSetterType" : "DisconnectCustomKeyStoreRequest"
},
"methodName" : "disconnectCustomKeyStore",
"operationName" : "DisconnectCustomKeyStore",
"paginated" : false,
"returnType" : {
"returnType" : "DisconnectCustomKeyStoreResponse",
"documentation" : null
},
"syncReturnType" : "DisconnectCustomKeyStoreResponse"
},
"EnableKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "EnableKeyRequest",
"variableName" : "enableKeyRequest",
"variableType" : "EnableKeyRequest",
"documentation" : "",
"simpleType" : "EnableKeyRequest",
"variableSetterType" : "EnableKeyRequest"
},
"methodName" : "enableKey",
"operationName" : "EnableKey",
"paginated" : false,
"returnType" : {
"returnType" : "EnableKeyResponse",
"documentation" : null
},
"syncReturnType" : "EnableKeyResponse"
},
"EnableKeyRotation" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Enables automatic rotation of the key material for the specified symmetric customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "EnableKeyRotationRequest",
"variableName" : "enableKeyRotationRequest",
"variableType" : "EnableKeyRotationRequest",
"documentation" : "",
"simpleType" : "EnableKeyRotationRequest",
"variableSetterType" : "EnableKeyRotationRequest"
},
"methodName" : "enableKeyRotation",
"operationName" : "EnableKeyRotation",
"paginated" : false,
"returnType" : {
"returnType" : "EnableKeyRotationResponse",
"documentation" : null
},
"syncReturnType" : "EnableKeyRotationResponse"
},
"Encrypt" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases:
-
You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information.
-
You can use the Encrypt operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use the Encrypt operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B.
You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.
When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.
If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.
When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.
-
Symmetric CMKs
-
SYMMETRIC_DEFAULT: 4096 bytes
-
RSA_2048
-
RSAES_OAEP_SHA_1: 214 bytes
-
RSAES_OAEP_SHA_256: 190 bytes
-
RSA_3072
-
RSAES_OAEP_SHA_1: 342 bytes
-
RSAES_OAEP_SHA_256: 318 bytes
-
RSA_4096
-
RSAES_OAEP_SHA_1: 470 bytes
-
RSAES_OAEP_SHA_256: 446 bytes
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "EncryptRequest",
"variableName" : "encryptRequest",
"variableType" : "EncryptRequest",
"documentation" : "",
"simpleType" : "EncryptRequest",
"variableSetterType" : "EncryptRequest"
},
"methodName" : "encrypt",
"operationName" : "Encrypt",
"paginated" : false,
"returnType" : {
"returnType" : "EncryptResponse",
"documentation" : null
},
"syncReturnType" : "EncryptResponse"
},
"GenerateDataKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.
GenerateDataKey returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.
To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of AWS KMS:
-
Use the GenerateDataKey operation to get a data key.
-
Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.
-
Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.
To decrypt data outside of AWS KMS:
-
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
-
Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateDataKeyRequest",
"variableName" : "generateDataKeyRequest",
"variableType" : "GenerateDataKeyRequest",
"documentation" : "",
"simpleType" : "GenerateDataKeyRequest",
"variableSetterType" : "GenerateDataKeyRequest"
},
"methodName" : "generateDataKey",
"operationName" : "GenerateDataKey",
"paginated" : false,
"returnType" : {
"returnType" : "GenerateDataKeyResponse",
"documentation" : null
},
"syncReturnType" : "GenerateDataKeyResponse"
},
"GenerateDataKeyPair" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.
GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.
You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.
You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateDataKeyPairRequest",
"variableName" : "generateDataKeyPairRequest",
"variableType" : "GenerateDataKeyPairRequest",
"documentation" : "",
"simpleType" : "GenerateDataKeyPairRequest",
"variableSetterType" : "GenerateDataKeyPairRequest"
},
"methodName" : "generateDataKeyPair",
"operationName" : "GenerateDataKeyPair",
"paginated" : false,
"returnType" : {
"returnType" : "GenerateDataKeyPairResponse",
"documentation" : null
},
"syncReturnType" : "GenerateDataKeyPairResponse"
},
"GenerateDataKeyPairWithoutPlaintext" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key.
To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the KeySpec field in the DescribeKey response.
You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.
You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateDataKeyPairWithoutPlaintextRequest",
"variableName" : "generateDataKeyPairWithoutPlaintextRequest",
"variableType" : "GenerateDataKeyPairWithoutPlaintextRequest",
"documentation" : "",
"simpleType" : "GenerateDataKeyPairWithoutPlaintextRequest",
"variableSetterType" : "GenerateDataKeyPairWithoutPlaintextRequest"
},
"methodName" : "generateDataKeyPairWithoutPlaintext",
"operationName" : "GenerateDataKeyPairWithoutPlaintext",
"paginated" : false,
"returnType" : {
"returnType" : "GenerateDataKeyPairWithoutPlaintextResponse",
"documentation" : null
},
"syncReturnType" : "GenerateDataKeyPairWithoutPlaintextResponse"
},
"GenerateDataKeyWithoutPlaintext" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.
GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.
It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.
GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.
To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.
If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field.
You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateDataKeyWithoutPlaintextRequest",
"variableName" : "generateDataKeyWithoutPlaintextRequest",
"variableType" : "GenerateDataKeyWithoutPlaintextRequest",
"documentation" : "",
"simpleType" : "GenerateDataKeyWithoutPlaintextRequest",
"variableSetterType" : "GenerateDataKeyWithoutPlaintextRequest"
},
"methodName" : "generateDataKeyWithoutPlaintext",
"operationName" : "GenerateDataKeyWithoutPlaintext",
"paginated" : false,
"returnType" : {
"returnType" : "GenerateDataKeyWithoutPlaintextResponse",
"documentation" : null
},
"syncReturnType" : "GenerateDataKeyWithoutPlaintextResponse"
},
"GenerateRandom" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreInvalidStateException",
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateRandomRequest",
"variableName" : "generateRandomRequest",
"variableType" : "GenerateRandomRequest",
"documentation" : "",
"simpleType" : "GenerateRandomRequest",
"variableSetterType" : "GenerateRandomRequest"
},
"methodName" : "generateRandom",
"operationName" : "GenerateRandom",
"paginated" : false,
"returnType" : {
"returnType" : "GenerateRandomResponse",
"documentation" : null
},
"syncReturnType" : "GenerateRandomResponse"
},
"GetKeyPolicy" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetKeyPolicyRequest",
"variableName" : "getKeyPolicyRequest",
"variableType" : "GetKeyPolicyRequest",
"documentation" : "",
"simpleType" : "GetKeyPolicyRequest",
"variableSetterType" : "GetKeyPolicyRequest"
},
"methodName" : "getKeyPolicy",
"operationName" : "GetKeyPolicy",
"paginated" : false,
"returnType" : {
"returnType" : "GetKeyPolicyResponse",
"documentation" : null
},
"syncReturnType" : "GetKeyPolicyResponse"
},
"GetKeyRotationStatus" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always false.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
-
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
-
Pending deletion: While a CMK is pending deletion, its key rotation status is false and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetKeyRotationStatusRequest",
"variableName" : "getKeyRotationStatusRequest",
"variableType" : "GetKeyRotationStatusRequest",
"documentation" : "",
"simpleType" : "GetKeyRotationStatusRequest",
"variableSetterType" : "GetKeyRotationStatusRequest"
},
"methodName" : "getKeyRotationStatus",
"operationName" : "GetKeyRotationStatus",
"paginated" : false,
"returnType" : {
"returnType" : "GetKeyRotationStatusResponse",
"documentation" : null
},
"syncReturnType" : "GetKeyRotationStatusResponse"
},
"GetParametersForImport" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.
To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetParametersForImportRequest",
"variableName" : "getParametersForImportRequest",
"variableType" : "GetParametersForImportRequest",
"documentation" : "",
"simpleType" : "GetParametersForImportRequest",
"variableSetterType" : "GetParametersForImportRequest"
},
"methodName" : "getParametersForImport",
"operationName" : "GetParametersForImport",
"paginated" : false,
"returnType" : {
"returnType" : "GetParametersForImportResponse",
"documentation" : null
},
"syncReturnType" : "GetParametersForImportResponse"
},
"GetPublicKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations for Downloading Public Keys.
To help you use the public key safely outside of AWS KMS, GetPublicKey returns important information about the public key in the response, including:
-
CustomerMasterKeySpec: The type of key material in the public key, such as RSA_4096 or ECC_NIST_P521.
-
KeyUsage: Whether the key is used for encryption or signing.
-
EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the signing algorithms for the key.
Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetPublicKeyRequest",
"variableName" : "getPublicKeyRequest",
"variableType" : "GetPublicKeyRequest",
"documentation" : "",
"simpleType" : "GetPublicKeyRequest",
"variableSetterType" : "GetPublicKeyRequest"
},
"methodName" : "getPublicKey",
"operationName" : "GetPublicKey",
"paginated" : false,
"returnType" : {
"returnType" : "GetPublicKeyResponse",
"documentation" : null
},
"syncReturnType" : "GetPublicKeyResponse"
},
"ImportKeyMaterial" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response.
When calling this operation, you must specify the following values:
-
The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL.
To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.)
-
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
-
The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport response.
-
Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK.
If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and repeat the import procedure. For help, see How To Import Key Material in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidCiphertextException",
"documentation" : "From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
From the ImportKeyMaterial operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material.
",
"httpStatusCode" : null
}, {
"exceptionName" : "IncorrectKeyMaterialException",
"documentation" : "The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this customer master key (CMK).
",
"httpStatusCode" : null
}, {
"exceptionName" : "ExpiredImportTokenException",
"documentation" : "The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidImportTokenException",
"documentation" : "The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportKeyMaterialRequest",
"variableName" : "importKeyMaterialRequest",
"variableType" : "ImportKeyMaterialRequest",
"documentation" : "",
"simpleType" : "ImportKeyMaterialRequest",
"variableSetterType" : "ImportKeyMaterialRequest"
},
"methodName" : "importKeyMaterial",
"operationName" : "ImportKeyMaterial",
"paginated" : false,
"returnType" : {
"returnType" : "ImportKeyMaterialResponse",
"documentation" : null
},
"syncReturnType" : "ImportKeyMaterialResponse"
},
"ListAliases" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter.
The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format aws/<service-name>, such as aws/dynamodb.
The response might also include aliases that have no TargetKeyId field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListAliasesRequest",
"variableName" : "listAliasesRequest",
"variableType" : "ListAliasesRequest",
"documentation" : "",
"simpleType" : "ListAliasesRequest",
"variableSetterType" : "ListAliasesRequest"
},
"methodName" : "listAliases",
"operationName" : "ListAliases",
"paginated" : true,
"returnType" : {
"returnType" : "ListAliasesResponse",
"documentation" : null
},
"syncReturnType" : "ListAliasesResponse"
},
"ListGrants" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListGrantsRequest",
"variableName" : "listGrantsRequest",
"variableType" : "ListGrantsRequest",
"documentation" : "",
"simpleType" : "ListGrantsRequest",
"variableSetterType" : "ListGrantsRequest"
},
"methodName" : "listGrants",
"operationName" : "ListGrants",
"paginated" : true,
"returnType" : {
"returnType" : "ListGrantsResponse",
"documentation" : null
},
"syncReturnType" : "ListGrantsResponse"
},
"ListKeyPolicies" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListKeyPoliciesRequest",
"variableName" : "listKeyPoliciesRequest",
"variableType" : "ListKeyPoliciesRequest",
"documentation" : "",
"simpleType" : "ListKeyPoliciesRequest",
"variableSetterType" : "ListKeyPoliciesRequest"
},
"methodName" : "listKeyPolicies",
"operationName" : "ListKeyPolicies",
"paginated" : true,
"returnType" : {
"returnType" : "ListKeyPoliciesResponse",
"documentation" : null
},
"syncReturnType" : "ListKeyPoliciesResponse"
},
"ListKeys" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListKeysRequest",
"variableName" : "listKeysRequest",
"variableType" : "ListKeysRequest",
"documentation" : "",
"simpleType" : "ListKeysRequest",
"variableSetterType" : "ListKeysRequest"
},
"methodName" : "listKeys",
"operationName" : "ListKeys",
"paginated" : true,
"returnType" : {
"returnType" : "ListKeysResponse",
"documentation" : null
},
"syncReturnType" : "ListKeysResponse"
},
"ListResourceTags" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of all tags for the specified customer master key (CMK).
You cannot perform this operation on a CMK in a different AWS account.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListResourceTagsRequest",
"variableName" : "listResourceTagsRequest",
"variableType" : "ListResourceTagsRequest",
"documentation" : "",
"simpleType" : "ListResourceTagsRequest",
"variableSetterType" : "ListResourceTagsRequest"
},
"methodName" : "listResourceTags",
"operationName" : "ListResourceTags",
"paginated" : false,
"returnType" : {
"returnType" : "ListResourceTagsResponse",
"documentation" : null
},
"syncReturnType" : "ListResourceTagsResponse"
},
"ListRetirableGrants" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListRetirableGrantsRequest",
"variableName" : "listRetirableGrantsRequest",
"variableType" : "ListRetirableGrantsRequest",
"documentation" : "",
"simpleType" : "ListRetirableGrantsRequest",
"variableSetterType" : "ListRetirableGrantsRequest"
},
"methodName" : "listRetirableGrants",
"operationName" : "ListRetirableGrants",
"paginated" : false,
"returnType" : {
"returnType" : "ListRetirableGrantsResponse",
"documentation" : null
},
"syncReturnType" : "ListRetirableGrantsResponse"
},
"PutKeyPolicy" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "MalformedPolicyDocumentException",
"documentation" : "The request was rejected because the specified policy is not syntactically or semantically correct.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutKeyPolicyRequest",
"variableName" : "putKeyPolicyRequest",
"variableType" : "PutKeyPolicyRequest",
"documentation" : "",
"simpleType" : "PutKeyPolicyRequest",
"variableSetterType" : "PutKeyPolicyRequest"
},
"methodName" : "putKeyPolicy",
"operationName" : "PutKeyPolicy",
"paginated" : false,
"returnType" : {
"returnType" : "PutKeyPolicyResponse",
"documentation" : null
},
"syncReturnType" : "PutKeyPolicyResponse"
},
"ReEncrypt" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.
The ReEncrypt operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.
When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.
-
If your ciphertext was encrypted under an asymmetric CMK, you must identify the source CMK, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.
-
It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the ReEncrypt operation fails.
-
To reencrypt the data, you must specify the destination CMK, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.
When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
Unlike other AWS KMS API operations, ReEncrypt callers must have two permissions:
-
kms:ReEncryptFrom permission on the source CMK
-
kms:ReEncryptTo permission on the destination CMK
To permit reencryption from or to a CMK, include the \"kms:ReEncrypt*\" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidCiphertextException",
"documentation" : "From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
From the ImportKeyMaterial operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "IncorrectKeyException",
"documentation" : "The request was rejected because the specified CMK cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same CMK that was used to encrypt the ciphertext.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ReEncryptRequest",
"variableName" : "reEncryptRequest",
"variableType" : "ReEncryptRequest",
"documentation" : "",
"simpleType" : "ReEncryptRequest",
"variableSetterType" : "ReEncryptRequest"
},
"methodName" : "reEncrypt",
"operationName" : "ReEncrypt",
"paginated" : false,
"returnType" : {
"returnType" : "ReEncryptResponse",
"documentation" : null
},
"syncReturnType" : "ReEncryptResponse"
},
"RetireGrant" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
-
The AWS account (root user) under which the grant was created
-
The RetiringPrincipal, if present in the grant
-
The GranteePrincipal, if RetireGrant is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantIdException",
"documentation" : "The request was rejected because the specified GrantId is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RetireGrantRequest",
"variableName" : "retireGrantRequest",
"variableType" : "RetireGrantRequest",
"documentation" : "",
"simpleType" : "RetireGrantRequest",
"variableSetterType" : "RetireGrantRequest"
},
"methodName" : "retireGrant",
"operationName" : "RetireGrant",
"paginated" : false,
"returnType" : {
"returnType" : "RetireGrantResponse",
"documentation" : null
},
"syncReturnType" : "RetireGrantResponse"
},
"RevokeGrant" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantIdException",
"documentation" : "The request was rejected because the specified GrantId is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RevokeGrantRequest",
"variableName" : "revokeGrantRequest",
"variableType" : "RevokeGrantRequest",
"documentation" : "",
"simpleType" : "RevokeGrantRequest",
"variableSetterType" : "RevokeGrantRequest"
},
"methodName" : "revokeGrant",
"operationName" : "RevokeGrant",
"paginated" : false,
"returnType" : {
"returnType" : "RevokeGrantResponse",
"documentation" : null
},
"syncReturnType" : "RevokeGrantResponse"
},
"ScheduleKeyDeletion" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.
If you schedule deletion of a CMK from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.
You cannot perform this operation on a CMK in a different AWS account.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ScheduleKeyDeletionRequest",
"variableName" : "scheduleKeyDeletionRequest",
"variableType" : "ScheduleKeyDeletionRequest",
"documentation" : "",
"simpleType" : "ScheduleKeyDeletionRequest",
"variableSetterType" : "ScheduleKeyDeletionRequest"
},
"methodName" : "scheduleKeyDeletion",
"operationName" : "ScheduleKeyDeletion",
"paginated" : false,
"returnType" : {
"returnType" : "ScheduleKeyDeletionResponse",
"documentation" : null
},
"syncReturnType" : "ScheduleKeyDeletionResponse"
},
"Sign" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a digital signature for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the Verify operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed.
To use the Sign operation, provide the following information:
-
Use the KeyId parameter to identify an asymmetric CMK with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a CMK, use the DescribeKey operation. The caller must have kms:Sign permission on the CMK.
-
Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter.
-
Choose a signing algorithm that is compatible with the CMK.
When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.
To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of AWS KMS.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "SignRequest",
"variableName" : "signRequest",
"variableType" : "SignRequest",
"documentation" : "",
"simpleType" : "SignRequest",
"variableSetterType" : "SignRequest"
},
"methodName" : "sign",
"operationName" : "Sign",
"paginated" : false,
"returnType" : {
"returnType" : "SignResponse",
"documentation" : null
},
"syncReturnType" : "SignResponse"
},
"TagResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "TagException",
"documentation" : "The request was rejected because one or more tags are not valid.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TagResourceRequest",
"variableName" : "tagResourceRequest",
"variableType" : "TagResourceRequest",
"documentation" : "",
"simpleType" : "TagResourceRequest",
"variableSetterType" : "TagResourceRequest"
},
"methodName" : "tagResource",
"operationName" : "TagResource",
"paginated" : false,
"returnType" : {
"returnType" : "TagResourceResponse",
"documentation" : null
},
"syncReturnType" : "TagResourceResponse"
},
"UntagResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "TagException",
"documentation" : "The request was rejected because one or more tags are not valid.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UntagResourceRequest",
"variableName" : "untagResourceRequest",
"variableType" : "UntagResourceRequest",
"documentation" : "",
"simpleType" : "UntagResourceRequest",
"variableSetterType" : "UntagResourceRequest"
},
"methodName" : "untagResource",
"operationName" : "UntagResource",
"paginated" : false,
"returnType" : {
"returnType" : "UntagResourceResponse",
"documentation" : null
},
"syncReturnType" : "UntagResourceResponse"
},
"UpdateAlias" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account.
The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.
You cannot use UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.
Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateAliasRequest",
"variableName" : "updateAliasRequest",
"variableType" : "UpdateAliasRequest",
"documentation" : "",
"simpleType" : "UpdateAliasRequest",
"variableSetterType" : "UpdateAliasRequest"
},
"methodName" : "updateAlias",
"operationName" : "UpdateAlias",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateAliasResponse",
"documentation" : null
},
"syncReturnType" : "UpdateAliasResponse"
},
"UpdateCustomKeyStore" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.
You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.
Use the parameters of UpdateCustomKeyStore to edit your keystore settings.
-
Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
-
Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.
-
Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "CustomKeyStoreNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreNameInUseException",
"documentation" : "The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterNotFoundException",
"documentation" : "The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterNotRelatedException",
"documentation" : "The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.
Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CustomKeyStoreInvalidStateException",
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterNotActiveException",
"documentation" : "The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.
",
"httpStatusCode" : null
}, {
"exceptionName" : "CloudHsmClusterInvalidConfigurationException",
"documentation" : "The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
-
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
-
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateCustomKeyStoreRequest",
"variableName" : "updateCustomKeyStoreRequest",
"variableType" : "UpdateCustomKeyStoreRequest",
"documentation" : "",
"simpleType" : "UpdateCustomKeyStoreRequest",
"variableSetterType" : "UpdateCustomKeyStoreRequest"
},
"methodName" : "updateCustomKeyStore",
"operationName" : "UpdateCustomKeyStore",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateCustomKeyStoreResponse",
"documentation" : null
},
"syncReturnType" : "UpdateCustomKeyStoreResponse"
},
"UpdateKeyDescription" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateKeyDescriptionRequest",
"variableName" : "updateKeyDescriptionRequest",
"variableType" : "UpdateKeyDescriptionRequest",
"documentation" : "",
"simpleType" : "UpdateKeyDescriptionRequest",
"variableSetterType" : "UpdateKeyDescriptionRequest"
},
"methodName" : "updateKeyDescription",
"operationName" : "UpdateKeyDescription",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateKeyDescriptionResponse",
"documentation" : null
},
"syncReturnType" : "UpdateKeyDescriptionResponse"
},
"Verify" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.
A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.
You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
",
"endpointCacheRequired" : false,
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the specified CMK was not available. You can retry the request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected for one of the following reasons:
-
The KeyUsage value of the CMK is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because the specified grant token is not valid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidStateException",
"documentation" : "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
",
"httpStatusCode" : null
}, {
"exceptionName" : "KmsInvalidSignatureException",
"documentation" : "The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified CMK and signing algorithm.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "VerifyRequest",
"variableName" : "verifyRequest",
"variableType" : "VerifyRequest",
"documentation" : "",
"simpleType" : "VerifyRequest",
"variableSetterType" : "VerifyRequest"
},
"methodName" : "verify",
"operationName" : "Verify",
"paginated" : false,
"returnType" : {
"returnType" : "VerifyResponse",
"documentation" : null
},
"syncReturnType" : "VerifyResponse"
}
},
"shapes" : {
"AlgorithmSpec" : {
"c2jName" : "AlgorithmSpec",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "RSAES_PKCS1_V1_5",
"value" : "RSAES_PKCS1_V1_5"
}, {
"name" : "RSAES_OAEP_SHA_1",
"value" : "RSAES_OAEP_SHA_1"
}, {
"name" : "RSAES_OAEP_SHA_256",
"value" : "RSAES_OAEP_SHA_256"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "AlgorithmSpec",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AlgorithmSpec",
"variableName" : "algorithmSpec",
"variableType" : "AlgorithmSpec",
"documentation" : null,
"simpleType" : "AlgorithmSpec",
"variableSetterType" : "AlgorithmSpec"
},
"wrapper" : false,
"xmlNamespace" : null
},
"AliasListEntry" : {
"c2jName" : "AliasListEntry",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Contains information about an alias.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@return String that contains the alias. This value begins with alias/.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "String that contains the alias. This value begins with alias/.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@return String that contains the alias. This value begins with alias/.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the alias. This value begins with alias/.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasArn",
"beanStyleSetterMethodName" : "setAliasArn",
"c2jName" : "AliasArn",
"c2jShape" : "ArnType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the key ARN.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasArn(String)}.\n@param aliasArn a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasArn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the key ARN.
\n@return String that contains the key ARN.\n@deprecated Use {@link #aliasArn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasArn(String)}\n",
"documentation" : "String that contains the key ARN.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasArn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasArn",
"fluentSetterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasArn",
"getterDocumentation" : "String that contains the key ARN.
\n@return String that contains the key ARN.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasArn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasArn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasArn",
"sensitive" : false,
"setterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.",
"setterMethodName" : "setAliasArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "String that contains the key ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTargetKeyId",
"beanStyleSetterMethodName" : "setTargetKeyId",
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #targetKeyId(String)}.\n@param targetKeyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #targetKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@return String that contains the key identifier referred to by the alias.\n@deprecated Use {@link #targetKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #targetKeyId(String)}\n",
"documentation" : "String that contains the key identifier referred to by the alias.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TargetKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTargetKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "targetKeyId",
"fluentSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "targetKeyId",
"getterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@return String that contains the key identifier referred to by the alias.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TargetKeyId",
"sensitive" : false,
"setterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.",
"setterMethodName" : "setTargetKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "String that contains the key identifier referred to by the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AliasArn" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasArn",
"beanStyleSetterMethodName" : "setAliasArn",
"c2jName" : "AliasArn",
"c2jShape" : "ArnType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the key ARN.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasArn(String)}.\n@param aliasArn a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasArn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the key ARN.
\n@return String that contains the key ARN.\n@deprecated Use {@link #aliasArn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasArn(String)}\n",
"documentation" : "String that contains the key ARN.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasArn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasArn",
"fluentSetterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasArn",
"getterDocumentation" : "String that contains the key ARN.
\n@return String that contains the key ARN.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasArn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasArn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasArn",
"sensitive" : false,
"setterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.",
"setterMethodName" : "setAliasArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "String that contains the key ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"AliasName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@return String that contains the alias. This value begins with alias/.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "String that contains the alias. This value begins with alias/.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@return String that contains the alias. This value begins with alias/.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the alias. This value begins with alias/.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"TargetKeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTargetKeyId",
"beanStyleSetterMethodName" : "setTargetKeyId",
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #targetKeyId(String)}.\n@param targetKeyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #targetKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@return String that contains the key identifier referred to by the alias.\n@deprecated Use {@link #targetKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #targetKeyId(String)}\n",
"documentation" : "String that contains the key identifier referred to by the alias.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TargetKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTargetKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "targetKeyId",
"fluentSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "targetKeyId",
"getterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@return String that contains the key identifier referred to by the alias.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TargetKeyId",
"sensitive" : false,
"setterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.",
"setterMethodName" : "setTargetKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "String that contains the key identifier referred to by the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@return String that contains the alias. This value begins with alias/.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "String that contains the alias. This value begins with alias/.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@return String that contains the alias. This value begins with alias/.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "String that contains the alias. This value begins with alias/.
\n@param aliasName String that contains the alias. This value begins with alias/.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the alias. This value begins with alias/.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasArn",
"beanStyleSetterMethodName" : "setAliasArn",
"c2jName" : "AliasArn",
"c2jShape" : "ArnType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the key ARN.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasArn(String)}.\n@param aliasArn a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasArn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the key ARN.
\n@return String that contains the key ARN.\n@deprecated Use {@link #aliasArn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasArn(String)}\n",
"documentation" : "String that contains the key ARN.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasArn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasArn",
"fluentSetterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasArn",
"getterDocumentation" : "String that contains the key ARN.
\n@return String that contains the key ARN.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasArn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasArn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasArn",
"sensitive" : false,
"setterDocumentation" : "String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.",
"setterMethodName" : "setAliasArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "String that contains the key ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTargetKeyId",
"beanStyleSetterMethodName" : "setTargetKeyId",
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #targetKeyId(String)}.\n@param targetKeyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #targetKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@return String that contains the key identifier referred to by the alias.\n@deprecated Use {@link #targetKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #targetKeyId(String)}\n",
"documentation" : "String that contains the key identifier referred to by the alias.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TargetKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTargetKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "targetKeyId",
"fluentSetterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "targetKeyId",
"getterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@return String that contains the key identifier referred to by the alias.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TargetKeyId",
"sensitive" : false,
"setterDocumentation" : "String that contains the key identifier referred to by the alias.
\n@param targetKeyId String that contains the key identifier referred to by the alias.",
"setterMethodName" : "setTargetKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "String that contains the key identifier referred to by the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "AliasListEntry",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AliasListEntry",
"variableName" : "aliasListEntry",
"variableType" : "AliasListEntry",
"documentation" : null,
"simpleType" : "AliasListEntry",
"variableSetterType" : "AliasListEntry"
},
"wrapper" : false,
"xmlNamespace" : null
},
"AlreadyExistsException" : {
"c2jName" : "AlreadyExistsException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because it attempted to create a resource that already exists.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "AlreadyExistsException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "AlreadyExistsException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "AlreadyExistsException",
"variableName" : "alreadyExistsException",
"variableType" : "AlreadyExistsException",
"documentation" : null,
"simpleType" : "AlreadyExistsException",
"variableSetterType" : "AlreadyExistsException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CancelKeyDeletionRequest" : {
"c2jName" : "CancelKeyDeletionRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CancelKeyDeletion",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CancelKeyDeletion",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "CancelKeyDeletionRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CancelKeyDeletionRequest",
"variableName" : "cancelKeyDeletionRequest",
"variableType" : "CancelKeyDeletionRequest",
"documentation" : null,
"simpleType" : "CancelKeyDeletionRequest",
"variableSetterType" : "CancelKeyDeletionRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CancelKeyDeletionResponse" : {
"c2jName" : "CancelKeyDeletionResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@return The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@return The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@return The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@return The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@return The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@return The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CancelKeyDeletionResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CancelKeyDeletionResponse",
"variableName" : "cancelKeyDeletionResponse",
"variableType" : "CancelKeyDeletionResponse",
"documentation" : null,
"simpleType" : "CancelKeyDeletionResponse",
"variableSetterType" : "CancelKeyDeletionResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CloudHsmClusterInUseException" : {
"c2jName" : "CloudHsmClusterInUseException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CloudHsmClusterInUseException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CloudHsmClusterInUseException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CloudHsmClusterInUseException",
"variableName" : "cloudHsmClusterInUseException",
"variableType" : "CloudHsmClusterInUseException",
"documentation" : null,
"simpleType" : "CloudHsmClusterInUseException",
"variableSetterType" : "CloudHsmClusterInUseException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CloudHsmClusterInvalidConfigurationException" : {
"c2jName" : "CloudHsmClusterInvalidConfigurationException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
-
The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
-
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CloudHsmClusterInvalidConfigurationException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CloudHsmClusterInvalidConfigurationException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CloudHsmClusterInvalidConfigurationException",
"variableName" : "cloudHsmClusterInvalidConfigurationException",
"variableType" : "CloudHsmClusterInvalidConfigurationException",
"documentation" : null,
"simpleType" : "CloudHsmClusterInvalidConfigurationException",
"variableSetterType" : "CloudHsmClusterInvalidConfigurationException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CloudHsmClusterNotActiveException" : {
"c2jName" : "CloudHsmClusterNotActiveException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CloudHsmClusterNotActiveException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CloudHsmClusterNotActiveException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CloudHsmClusterNotActiveException",
"variableName" : "cloudHsmClusterNotActiveException",
"variableType" : "CloudHsmClusterNotActiveException",
"documentation" : null,
"simpleType" : "CloudHsmClusterNotActiveException",
"variableSetterType" : "CloudHsmClusterNotActiveException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CloudHsmClusterNotFoundException" : {
"c2jName" : "CloudHsmClusterNotFoundException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CloudHsmClusterNotFoundException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CloudHsmClusterNotFoundException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CloudHsmClusterNotFoundException",
"variableName" : "cloudHsmClusterNotFoundException",
"variableType" : "CloudHsmClusterNotFoundException",
"documentation" : null,
"simpleType" : "CloudHsmClusterNotFoundException",
"variableSetterType" : "CloudHsmClusterNotFoundException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CloudHsmClusterNotRelatedException" : {
"c2jName" : "CloudHsmClusterNotRelatedException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.
Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CloudHsmClusterNotRelatedException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CloudHsmClusterNotRelatedException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CloudHsmClusterNotRelatedException",
"variableName" : "cloudHsmClusterNotRelatedException",
"variableType" : "CloudHsmClusterNotRelatedException",
"documentation" : null,
"simpleType" : "CloudHsmClusterNotRelatedException",
"variableSetterType" : "CloudHsmClusterNotRelatedException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ConnectCustomKeyStoreRequest" : {
"c2jName" : "ConnectCustomKeyStoreRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "ConnectCustomKeyStore",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.ConnectCustomKeyStore",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "CustomKeyStoreId" ],
"shapeName" : "ConnectCustomKeyStoreRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "ConnectCustomKeyStoreRequest",
"variableName" : "connectCustomKeyStoreRequest",
"variableType" : "ConnectCustomKeyStoreRequest",
"documentation" : null,
"simpleType" : "ConnectCustomKeyStoreRequest",
"variableSetterType" : "ConnectCustomKeyStoreRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ConnectCustomKeyStoreResponse" : {
"c2jName" : "ConnectCustomKeyStoreResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ConnectCustomKeyStoreResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ConnectCustomKeyStoreResponse",
"variableName" : "connectCustomKeyStoreResponse",
"variableType" : "ConnectCustomKeyStoreResponse",
"documentation" : null,
"simpleType" : "ConnectCustomKeyStoreResponse",
"variableSetterType" : "ConnectCustomKeyStoreResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ConnectionErrorCodeType" : {
"c2jName" : "ConnectionErrorCodeType",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "INVALID_CREDENTIALS",
"value" : "INVALID_CREDENTIALS"
}, {
"name" : "CLUSTER_NOT_FOUND",
"value" : "CLUSTER_NOT_FOUND"
}, {
"name" : "NETWORK_ERRORS",
"value" : "NETWORK_ERRORS"
}, {
"name" : "INTERNAL_ERROR",
"value" : "INTERNAL_ERROR"
}, {
"name" : "INSUFFICIENT_CLOUDHSM_HSMS",
"value" : "INSUFFICIENT_CLOUDHSM_HSMS"
}, {
"name" : "USER_LOCKED_OUT",
"value" : "USER_LOCKED_OUT"
}, {
"name" : "USER_NOT_FOUND",
"value" : "USER_NOT_FOUND"
}, {
"name" : "USER_LOGGED_IN",
"value" : "USER_LOGGED_IN"
}, {
"name" : "SUBNET_NOT_FOUND",
"value" : "SUBNET_NOT_FOUND"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ConnectionErrorCodeType",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ConnectionErrorCodeType",
"variableName" : "connectionErrorCodeType",
"variableType" : "ConnectionErrorCodeType",
"documentation" : null,
"simpleType" : "ConnectionErrorCodeType",
"variableSetterType" : "ConnectionErrorCodeType"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ConnectionStateType" : {
"c2jName" : "ConnectionStateType",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "CONNECTED",
"value" : "CONNECTED"
}, {
"name" : "CONNECTING",
"value" : "CONNECTING"
}, {
"name" : "FAILED",
"value" : "FAILED"
}, {
"name" : "DISCONNECTED",
"value" : "DISCONNECTED"
}, {
"name" : "DISCONNECTING",
"value" : "DISCONNECTING"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ConnectionStateType",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ConnectionStateType",
"variableName" : "connectionStateType",
"variableType" : "ConnectionStateType",
"documentation" : null,
"simpleType" : "ConnectionStateType",
"variableSetterType" : "ConnectionStateType"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateAliasRequest" : {
"c2jName" : "CreateAliasRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CreateAlias",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateAlias",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@return Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@return Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTargetKeyId",
"beanStyleSetterMethodName" : "setTargetKeyId",
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #targetKeyId(String)}.\n@param targetKeyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #targetKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@return Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #targetKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #targetKeyId(String)}\n",
"documentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TargetKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTargetKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "targetKeyId",
"fluentSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "targetKeyId",
"getterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@return Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TargetKeyId",
"sensitive" : false,
"setterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setTargetKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AliasName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@return Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@return Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"TargetKeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTargetKeyId",
"beanStyleSetterMethodName" : "setTargetKeyId",
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #targetKeyId(String)}.\n@param targetKeyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #targetKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@return Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #targetKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #targetKeyId(String)}\n",
"documentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TargetKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTargetKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "targetKeyId",
"fluentSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "targetKeyId",
"getterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@return Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TargetKeyId",
"sensitive" : false,
"setterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setTargetKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@return Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@return Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
\n@param aliasName Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTargetKeyId",
"beanStyleSetterMethodName" : "setTargetKeyId",
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #targetKeyId(String)}.\n@param targetKeyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #targetKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@return Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #targetKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #targetKeyId(String)}\n",
"documentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TargetKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTargetKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "targetKeyId",
"fluentSetterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "targetKeyId",
"getterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@return Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TargetKeyId",
"sensitive" : false,
"setterDocumentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
\n@param targetKeyId Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setTargetKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "AliasName", "TargetKeyId" ],
"shapeName" : "CreateAliasRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateAliasRequest",
"variableName" : "createAliasRequest",
"variableType" : "CreateAliasRequest",
"documentation" : null,
"simpleType" : "CreateAliasRequest",
"variableSetterType" : "CreateAliasRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateAliasResponse" : {
"c2jName" : "CreateAliasResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CreateAliasResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateAliasResponse",
"variableName" : "createAliasResponse",
"variableType" : "CreateAliasResponse",
"documentation" : null,
"simpleType" : "CreateAliasResponse",
"variableSetterType" : "CreateAliasResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateCustomKeyStoreRequest" : {
"c2jName" : "CreateCustomKeyStoreRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CreateCustomKeyStore",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateCustomKeyStore",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@return Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@return Specifies a friendly name for the custom key store. The name must be unique in your AWS account.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCloudHsmClusterId",
"beanStyleSetterMethodName" : "setCloudHsmClusterId",
"c2jName" : "CloudHsmClusterId",
"c2jShape" : "CloudHsmClusterIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #cloudHsmClusterId(String)}.\n@param cloudHsmClusterId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #cloudHsmClusterId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@return Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@deprecated Use {@link #cloudHsmClusterId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #cloudHsmClusterId(String)}\n",
"documentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CloudHsmClusterId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCloudHsmClusterId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "cloudHsmClusterId",
"fluentSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "cloudHsmClusterId",
"getterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@return Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CloudHsmClusterId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CloudHsmClusterId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CloudHsmClusterId",
"sensitive" : false,
"setterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.",
"setterMethodName" : "setCloudHsmClusterId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTrustAnchorCertificate",
"beanStyleSetterMethodName" : "setTrustAnchorCertificate",
"c2jName" : "TrustAnchorCertificate",
"c2jShape" : "TrustAnchorCertificateType",
"defaultConsumerFluentSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #trustAnchorCertificate(String)}.\n@param trustAnchorCertificate a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #trustAnchorCertificate(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@return Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@deprecated Use {@link #trustAnchorCertificate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #trustAnchorCertificate(String)}\n",
"documentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TrustAnchorCertificate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTrustAnchorCertificate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "trustAnchorCertificate",
"fluentSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "trustAnchorCertificate",
"getterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@return Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TrustAnchorCertificate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TrustAnchorCertificate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TrustAnchorCertificate",
"sensitive" : false,
"setterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.",
"setterMethodName" : "setTrustAnchorCertificate",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyStorePassword",
"beanStyleSetterMethodName" : "setKeyStorePassword",
"c2jName" : "KeyStorePassword",
"c2jShape" : "KeyStorePasswordType",
"defaultConsumerFluentSetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyStorePassword(String)}.\n@param keyStorePassword a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyStorePassword(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@return Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@deprecated Use {@link #keyStorePassword()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyStorePassword(String)}\n",
"documentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyStorePassword property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyStorePassword",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyStorePassword",
"fluentSetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyStorePassword",
"getterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@return Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyStorePassword",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyStorePassword",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyStorePassword",
"sensitive" : true,
"setterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.",
"setterMethodName" : "setKeyStorePassword",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyStorePassword",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyStorePassword",
"variableType" : "String",
"documentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CloudHsmClusterId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCloudHsmClusterId",
"beanStyleSetterMethodName" : "setCloudHsmClusterId",
"c2jName" : "CloudHsmClusterId",
"c2jShape" : "CloudHsmClusterIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #cloudHsmClusterId(String)}.\n@param cloudHsmClusterId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #cloudHsmClusterId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@return Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@deprecated Use {@link #cloudHsmClusterId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #cloudHsmClusterId(String)}\n",
"documentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CloudHsmClusterId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCloudHsmClusterId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "cloudHsmClusterId",
"fluentSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "cloudHsmClusterId",
"getterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@return Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CloudHsmClusterId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CloudHsmClusterId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CloudHsmClusterId",
"sensitive" : false,
"setterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.",
"setterMethodName" : "setCloudHsmClusterId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomKeyStoreName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@return Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@return Specifies a friendly name for the custom key store. The name must be unique in your AWS account.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyStorePassword" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyStorePassword",
"beanStyleSetterMethodName" : "setKeyStorePassword",
"c2jName" : "KeyStorePassword",
"c2jShape" : "KeyStorePasswordType",
"defaultConsumerFluentSetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyStorePassword(String)}.\n@param keyStorePassword a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyStorePassword(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@return Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@deprecated Use {@link #keyStorePassword()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyStorePassword(String)}\n",
"documentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyStorePassword property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyStorePassword",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyStorePassword",
"fluentSetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyStorePassword",
"getterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@return Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyStorePassword",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyStorePassword",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyStorePassword",
"sensitive" : true,
"setterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.",
"setterMethodName" : "setKeyStorePassword",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyStorePassword",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyStorePassword",
"variableType" : "String",
"documentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"TrustAnchorCertificate" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTrustAnchorCertificate",
"beanStyleSetterMethodName" : "setTrustAnchorCertificate",
"c2jName" : "TrustAnchorCertificate",
"c2jShape" : "TrustAnchorCertificateType",
"defaultConsumerFluentSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #trustAnchorCertificate(String)}.\n@param trustAnchorCertificate a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #trustAnchorCertificate(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@return Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@deprecated Use {@link #trustAnchorCertificate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #trustAnchorCertificate(String)}\n",
"documentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TrustAnchorCertificate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTrustAnchorCertificate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "trustAnchorCertificate",
"fluentSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "trustAnchorCertificate",
"getterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@return Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TrustAnchorCertificate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TrustAnchorCertificate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TrustAnchorCertificate",
"sensitive" : false,
"setterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.",
"setterMethodName" : "setTrustAnchorCertificate",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@return Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@return Specifies a friendly name for the custom key store. The name must be unique in your AWS account.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
\n@param customKeyStoreName Specifies a friendly name for the custom key store. The name must be unique in your AWS account.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCloudHsmClusterId",
"beanStyleSetterMethodName" : "setCloudHsmClusterId",
"c2jName" : "CloudHsmClusterId",
"c2jShape" : "CloudHsmClusterIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #cloudHsmClusterId(String)}.\n@param cloudHsmClusterId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #cloudHsmClusterId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@return Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@deprecated Use {@link #cloudHsmClusterId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #cloudHsmClusterId(String)}\n",
"documentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CloudHsmClusterId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCloudHsmClusterId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "cloudHsmClusterId",
"fluentSetterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "cloudHsmClusterId",
"getterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@return Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CloudHsmClusterId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CloudHsmClusterId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CloudHsmClusterId",
"sensitive" : false,
"setterDocumentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
\n@param cloudHsmClusterId Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.",
"setterMethodName" : "setCloudHsmClusterId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : "Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTrustAnchorCertificate",
"beanStyleSetterMethodName" : "setTrustAnchorCertificate",
"c2jName" : "TrustAnchorCertificate",
"c2jShape" : "TrustAnchorCertificateType",
"defaultConsumerFluentSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #trustAnchorCertificate(String)}.\n@param trustAnchorCertificate a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #trustAnchorCertificate(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@return Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@deprecated Use {@link #trustAnchorCertificate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #trustAnchorCertificate(String)}\n",
"documentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TrustAnchorCertificate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTrustAnchorCertificate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "trustAnchorCertificate",
"fluentSetterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "trustAnchorCertificate",
"getterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@return Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TrustAnchorCertificate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TrustAnchorCertificate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TrustAnchorCertificate",
"sensitive" : false,
"setterDocumentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
\n@param trustAnchorCertificate Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.",
"setterMethodName" : "setTrustAnchorCertificate",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : "Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyStorePassword",
"beanStyleSetterMethodName" : "setKeyStorePassword",
"c2jName" : "KeyStorePassword",
"c2jShape" : "KeyStorePasswordType",
"defaultConsumerFluentSetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyStorePassword(String)}.\n@param keyStorePassword a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyStorePassword(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@return Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@deprecated Use {@link #keyStorePassword()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyStorePassword(String)}\n",
"documentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyStorePassword property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyStorePassword",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyStorePassword",
"fluentSetterDocumentation" : "Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyStorePassword",
"getterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@return Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyStorePassword",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyStorePassword",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyStorePassword",
"sensitive" : true,
"setterDocumentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
\n@param keyStorePassword Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf. The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.",
"setterMethodName" : "setKeyStorePassword",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyStorePassword",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyStorePassword",
"variableType" : "String",
"documentation" : "
Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "CustomKeyStoreName", "CloudHsmClusterId", "TrustAnchorCertificate", "KeyStorePassword" ],
"shapeName" : "CreateCustomKeyStoreRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateCustomKeyStoreRequest",
"variableName" : "createCustomKeyStoreRequest",
"variableType" : "CreateCustomKeyStoreRequest",
"documentation" : null,
"simpleType" : "CreateCustomKeyStoreRequest",
"variableSetterType" : "CreateCustomKeyStoreRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateCustomKeyStoreResponse" : {
"c2jName" : "CreateCustomKeyStoreResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the new custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the new custom key store.
\n@return A unique identifier for the new custom key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "A unique identifier for the new custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "A unique identifier for the new custom key store.
\n@return A unique identifier for the new custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "A unique identifier for the new custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the new custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the new custom key store.
\n@return A unique identifier for the new custom key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "A unique identifier for the new custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "A unique identifier for the new custom key store.
\n@return A unique identifier for the new custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "A unique identifier for the new custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the new custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the new custom key store.
\n@return A unique identifier for the new custom key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "A unique identifier for the new custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "A unique identifier for the new custom key store.
\n@return A unique identifier for the new custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the new custom key store.
\n@param customKeyStoreId A unique identifier for the new custom key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "A unique identifier for the new custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CreateCustomKeyStoreResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateCustomKeyStoreResponse",
"variableName" : "createCustomKeyStoreResponse",
"variableType" : "CreateCustomKeyStoreResponse",
"documentation" : null,
"simpleType" : "CreateCustomKeyStoreResponse",
"variableSetterType" : "CreateCustomKeyStoreResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateGrantRequest" : {
"c2jName" : "CreateGrantRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CreateGrant",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateGrant",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGranteePrincipal",
"beanStyleSetterMethodName" : "setGranteePrincipal",
"c2jName" : "GranteePrincipal",
"c2jShape" : "PrincipalIdType",
"defaultConsumerFluentSetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #granteePrincipal(String)}.\n@param granteePrincipal a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #granteePrincipal(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@deprecated Use {@link #granteePrincipal()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #granteePrincipal(String)}\n",
"documentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GranteePrincipal property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGranteePrincipal",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "granteePrincipal",
"fluentSetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "granteePrincipal",
"getterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GranteePrincipal",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GranteePrincipal",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GranteePrincipal",
"sensitive" : false,
"setterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"setterMethodName" : "setGranteePrincipal",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getRetiringPrincipal",
"beanStyleSetterMethodName" : "setRetiringPrincipal",
"c2jName" : "RetiringPrincipal",
"c2jShape" : "PrincipalIdType",
"defaultConsumerFluentSetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #retiringPrincipal(String)}.\n@param retiringPrincipal a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #retiringPrincipal(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@deprecated Use {@link #retiringPrincipal()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #retiringPrincipal(String)}\n",
"documentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the RetiringPrincipal property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasRetiringPrincipal",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "retiringPrincipal",
"fluentSetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "retiringPrincipal",
"getterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "RetiringPrincipal",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "RetiringPrincipal",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "RetiringPrincipal",
"sensitive" : false,
"setterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"setterMethodName" : "setRetiringPrincipal",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getOperations",
"beanStyleSetterMethodName" : "setOperations",
"c2jName" : "Operations",
"c2jShape" : "GrantOperationList",
"defaultConsumerFluentSetterDocumentation" : "A list of operations that the grant permits.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #operationsAsStrings(List)}.\n@param operations a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #operationsWithStrings(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of operations that the grant permits.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasOperations()} to see if a value was sent in this field.\n
\n@return A list of operations that the grant permits.\n@deprecated Use {@link #operationsAsStrings()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #operationsWithStrings(List)}\n",
"documentation" : "A list of operations that the grant permits.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Operations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasOperations",
"fluentEnumGetterMethodName" : "operations",
"fluentEnumSetterMethodName" : "operations",
"fluentGetterMethodName" : "operationsAsStrings",
"fluentSetterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "operationsWithStrings",
"getterDocumentation" : "A list of operations that the grant permits.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasOperations()} to see if a value was sent in this field.\n
\n@return A list of operations that the grant permits.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Operations",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Operations",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantOperation",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #memberAsString(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #member} will return {@link GrantOperation#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #memberAsString}.\n
\n@return The value of the Member property for this object.\n@see GrantOperation\n@deprecated Use {@link #memberAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : "GrantOperation",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : "member",
"fluentEnumSetterMethodName" : "member",
"fluentGetterMethodName" : "memberAsString",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #member} will return {@link GrantOperation#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #memberAsString}.\n
\n@return The value of the Member property for this object.\n@see GrantOperation",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Operations",
"sensitive" : false,
"setterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.",
"setterMethodName" : "setOperations",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "A list of operations that the grant permits.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConstraints",
"beanStyleSetterMethodName" : "setConstraints",
"c2jName" : "Constraints",
"c2jShape" : "GrantConstraints",
"defaultConsumerFluentSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\nThis is a convenience that creates an instance of the {@link GrantConstraints.Builder} avoiding the need to create one manually via {@link GrantConstraints#builder()}.\n\nWhen the {@link Consumer} completes, {@link GrantConstraints.Builder#build()} is called immediately and its result is passed to {@link #constraints(GrantConstraints)}.\n@param constraints a consumer that will call methods on {@link GrantConstraints.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #constraints(GrantConstraints)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@return Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@deprecated Use {@link #constraints()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #constraints(GrantConstraints)}\n",
"documentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Constraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConstraints",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "constraints",
"fluentSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "constraints",
"getterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@return Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .",
"getterModel" : {
"returnType" : "GrantConstraints",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Constraints",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Constraints",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Constraints",
"sensitive" : false,
"setterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .",
"setterMethodName" : "setConstraints",
"setterModel" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : null,
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "Name",
"c2jShape" : "GrantNameType",
"defaultConsumerFluentSetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@return A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@deprecated Use {@link #name()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #name(String)}\n",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Name property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@return A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"Constraints" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConstraints",
"beanStyleSetterMethodName" : "setConstraints",
"c2jName" : "Constraints",
"c2jShape" : "GrantConstraints",
"defaultConsumerFluentSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\nThis is a convenience that creates an instance of the {@link GrantConstraints.Builder} avoiding the need to create one manually via {@link GrantConstraints#builder()}.\n\nWhen the {@link Consumer} completes, {@link GrantConstraints.Builder#build()} is called immediately and its result is passed to {@link #constraints(GrantConstraints)}.\n@param constraints a consumer that will call methods on {@link GrantConstraints.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #constraints(GrantConstraints)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@return Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@deprecated Use {@link #constraints()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #constraints(GrantConstraints)}\n",
"documentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Constraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConstraints",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "constraints",
"fluentSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "constraints",
"getterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@return Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .",
"getterModel" : {
"returnType" : "GrantConstraints",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Constraints",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Constraints",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Constraints",
"sensitive" : false,
"setterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .",
"setterMethodName" : "setConstraints",
"setterModel" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : null,
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"GrantTokens" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"GranteePrincipal" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGranteePrincipal",
"beanStyleSetterMethodName" : "setGranteePrincipal",
"c2jName" : "GranteePrincipal",
"c2jShape" : "PrincipalIdType",
"defaultConsumerFluentSetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #granteePrincipal(String)}.\n@param granteePrincipal a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #granteePrincipal(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@deprecated Use {@link #granteePrincipal()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #granteePrincipal(String)}\n",
"documentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GranteePrincipal property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGranteePrincipal",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "granteePrincipal",
"fluentSetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "granteePrincipal",
"getterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GranteePrincipal",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GranteePrincipal",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GranteePrincipal",
"sensitive" : false,
"setterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"setterMethodName" : "setGranteePrincipal",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Name" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "Name",
"c2jShape" : "GrantNameType",
"defaultConsumerFluentSetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@return A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@deprecated Use {@link #name()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #name(String)}\n",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Name property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@return A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Operations" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getOperations",
"beanStyleSetterMethodName" : "setOperations",
"c2jName" : "Operations",
"c2jShape" : "GrantOperationList",
"defaultConsumerFluentSetterDocumentation" : "A list of operations that the grant permits.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #operationsAsStrings(List)}.\n@param operations a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #operationsWithStrings(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of operations that the grant permits.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasOperations()} to see if a value was sent in this field.\n
\n@return A list of operations that the grant permits.\n@deprecated Use {@link #operationsAsStrings()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #operationsWithStrings(List)}\n",
"documentation" : "A list of operations that the grant permits.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Operations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasOperations",
"fluentEnumGetterMethodName" : "operations",
"fluentEnumSetterMethodName" : "operations",
"fluentGetterMethodName" : "operationsAsStrings",
"fluentSetterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "operationsWithStrings",
"getterDocumentation" : "A list of operations that the grant permits.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasOperations()} to see if a value was sent in this field.\n
\n@return A list of operations that the grant permits.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Operations",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Operations",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantOperation",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #memberAsString(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #member} will return {@link GrantOperation#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #memberAsString}.\n
\n@return The value of the Member property for this object.\n@see GrantOperation\n@deprecated Use {@link #memberAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : "GrantOperation",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : "member",
"fluentEnumSetterMethodName" : "member",
"fluentGetterMethodName" : "memberAsString",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #member} will return {@link GrantOperation#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #memberAsString}.\n
\n@return The value of the Member property for this object.\n@see GrantOperation",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Operations",
"sensitive" : false,
"setterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.",
"setterMethodName" : "setOperations",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "A list of operations that the grant permits.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"RetiringPrincipal" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getRetiringPrincipal",
"beanStyleSetterMethodName" : "setRetiringPrincipal",
"c2jName" : "RetiringPrincipal",
"c2jShape" : "PrincipalIdType",
"defaultConsumerFluentSetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #retiringPrincipal(String)}.\n@param retiringPrincipal a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #retiringPrincipal(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@deprecated Use {@link #retiringPrincipal()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #retiringPrincipal(String)}\n",
"documentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the RetiringPrincipal property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasRetiringPrincipal",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "retiringPrincipal",
"fluentSetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "retiringPrincipal",
"getterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "RetiringPrincipal",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "RetiringPrincipal",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "RetiringPrincipal",
"sensitive" : false,
"setterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"setterMethodName" : "setRetiringPrincipal",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGranteePrincipal",
"beanStyleSetterMethodName" : "setGranteePrincipal",
"c2jName" : "GranteePrincipal",
"c2jShape" : "PrincipalIdType",
"defaultConsumerFluentSetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #granteePrincipal(String)}.\n@param granteePrincipal a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #granteePrincipal(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@deprecated Use {@link #granteePrincipal()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #granteePrincipal(String)}\n",
"documentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GranteePrincipal property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGranteePrincipal",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "granteePrincipal",
"fluentSetterDocumentation" : "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "granteePrincipal",
"getterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GranteePrincipal",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GranteePrincipal",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GranteePrincipal",
"sensitive" : false,
"setterDocumentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param granteePrincipal The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"setterMethodName" : "setGranteePrincipal",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : "
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getRetiringPrincipal",
"beanStyleSetterMethodName" : "setRetiringPrincipal",
"c2jName" : "RetiringPrincipal",
"c2jShape" : "PrincipalIdType",
"defaultConsumerFluentSetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #retiringPrincipal(String)}.\n@param retiringPrincipal a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #retiringPrincipal(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@deprecated Use {@link #retiringPrincipal()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #retiringPrincipal(String)}\n",
"documentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the RetiringPrincipal property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasRetiringPrincipal",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "retiringPrincipal",
"fluentSetterDocumentation" : "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "retiringPrincipal",
"getterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@return The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "RetiringPrincipal",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "RetiringPrincipal",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "RetiringPrincipal",
"sensitive" : false,
"setterDocumentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
\n@param retiringPrincipal The principal that is given permission to retire the grant by using RetireGrant operation. To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.",
"setterMethodName" : "setRetiringPrincipal",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : "
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getOperations",
"beanStyleSetterMethodName" : "setOperations",
"c2jName" : "Operations",
"c2jShape" : "GrantOperationList",
"defaultConsumerFluentSetterDocumentation" : "A list of operations that the grant permits.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #operationsAsStrings(List)}.\n@param operations a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #operationsWithStrings(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of operations that the grant permits.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasOperations()} to see if a value was sent in this field.\n
\n@return A list of operations that the grant permits.\n@deprecated Use {@link #operationsAsStrings()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #operationsWithStrings(List)}\n",
"documentation" : "A list of operations that the grant permits.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Operations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasOperations",
"fluentEnumGetterMethodName" : "operations",
"fluentEnumSetterMethodName" : "operations",
"fluentGetterMethodName" : "operationsAsStrings",
"fluentSetterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "operationsWithStrings",
"getterDocumentation" : "A list of operations that the grant permits.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasOperations()} to see if a value was sent in this field.\n
\n@return A list of operations that the grant permits.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Operations",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Operations",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantOperation",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #memberAsString(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #member} will return {@link GrantOperation#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #memberAsString}.\n
\n@return The value of the Member property for this object.\n@see GrantOperation\n@deprecated Use {@link #memberAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : "GrantOperation",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : "member",
"fluentEnumSetterMethodName" : "member",
"fluentGetterMethodName" : "memberAsString",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #member} will return {@link GrantOperation#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #memberAsString}.\n
\n@return The value of the Member property for this object.\n@see GrantOperation",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@see GrantOperation",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Operations",
"sensitive" : false,
"setterDocumentation" : "A list of operations that the grant permits.
\n@param operations A list of operations that the grant permits.",
"setterMethodName" : "setOperations",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "A list of operations that the grant permits.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConstraints",
"beanStyleSetterMethodName" : "setConstraints",
"c2jName" : "Constraints",
"c2jShape" : "GrantConstraints",
"defaultConsumerFluentSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\nThis is a convenience that creates an instance of the {@link GrantConstraints.Builder} avoiding the need to create one manually via {@link GrantConstraints#builder()}.\n\nWhen the {@link Consumer} completes, {@link GrantConstraints.Builder#build()} is called immediately and its result is passed to {@link #constraints(GrantConstraints)}.\n@param constraints a consumer that will call methods on {@link GrantConstraints.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #constraints(GrantConstraints)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@return Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@deprecated Use {@link #constraints()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #constraints(GrantConstraints)}\n",
"documentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Constraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConstraints",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "constraints",
"fluentSetterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "constraints",
"getterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@return Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .",
"getterModel" : {
"returnType" : "GrantConstraints",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Constraints",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Constraints",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Constraints",
"sensitive" : false,
"setterDocumentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
\n@param constraints Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .",
"setterMethodName" : "setConstraints",
"setterModel" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : null,
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .
",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "Name",
"c2jShape" : "GrantNameType",
"defaultConsumerFluentSetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@return A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@deprecated Use {@link #name()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #name(String)}\n",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Name property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@return A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
\n@param name A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId", "GranteePrincipal", "Operations" ],
"shapeName" : "CreateGrantRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateGrantRequest",
"variableName" : "createGrantRequest",
"variableType" : "CreateGrantRequest",
"documentation" : null,
"simpleType" : "CreateGrantRequest",
"variableSetterType" : "CreateGrantRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateGrantResponse" : {
"c2jName" : "CreateGrantResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGrantToken",
"beanStyleSetterMethodName" : "setGrantToken",
"c2jName" : "GrantToken",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #grantToken(String)}.\n@param grantToken a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantToken(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@return The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantToken()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantToken(String)}\n",
"documentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantToken property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantToken",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantToken",
"fluentSetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantToken",
"getterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@return The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantToken",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantToken",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GrantToken",
"sensitive" : false,
"setterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantToken",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGrantId",
"beanStyleSetterMethodName" : "setGrantId",
"c2jName" : "GrantId",
"c2jShape" : "GrantIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #grantId(String)}.\n@param grantId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@return The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@deprecated Use {@link #grantId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantId(String)}\n",
"documentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantId",
"fluentSetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantId",
"getterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@return The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GrantId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.",
"setterMethodName" : "setGrantId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"GrantId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGrantId",
"beanStyleSetterMethodName" : "setGrantId",
"c2jName" : "GrantId",
"c2jShape" : "GrantIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #grantId(String)}.\n@param grantId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@return The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@deprecated Use {@link #grantId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantId(String)}\n",
"documentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantId",
"fluentSetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantId",
"getterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@return The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GrantId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.",
"setterMethodName" : "setGrantId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"GrantToken" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGrantToken",
"beanStyleSetterMethodName" : "setGrantToken",
"c2jName" : "GrantToken",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #grantToken(String)}.\n@param grantToken a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantToken(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@return The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantToken()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantToken(String)}\n",
"documentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantToken property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantToken",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantToken",
"fluentSetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantToken",
"getterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@return The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantToken",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantToken",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GrantToken",
"sensitive" : false,
"setterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantToken",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGrantToken",
"beanStyleSetterMethodName" : "setGrantToken",
"c2jName" : "GrantToken",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #grantToken(String)}.\n@param grantToken a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantToken(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@return The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantToken()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantToken(String)}\n",
"documentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantToken property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantToken",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantToken",
"fluentSetterDocumentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantToken",
"getterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@return The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantToken",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantToken",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GrantToken",
"sensitive" : false,
"setterDocumentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantToken The grant token. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantToken",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : "
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getGrantId",
"beanStyleSetterMethodName" : "setGrantId",
"c2jName" : "GrantId",
"c2jShape" : "GrantIdType",
"defaultConsumerFluentSetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #grantId(String)}.\n@param grantId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@return The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@deprecated Use {@link #grantId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantId(String)}\n",
"documentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantId",
"fluentSetterDocumentation" : "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantId",
"getterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@return The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "GrantId",
"sensitive" : false,
"setterDocumentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
\n@param grantId The unique identifier for the grant. You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.",
"setterMethodName" : "setGrantId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : "
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CreateGrantResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateGrantResponse",
"variableName" : "createGrantResponse",
"variableType" : "CreateGrantResponse",
"documentation" : null,
"simpleType" : "CreateGrantResponse",
"variableSetterType" : "CreateGrantResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateKeyRequest" : {
"c2jName" : "CreateKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CreateKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPolicy",
"beanStyleSetterMethodName" : "setPolicy",
"c2jName" : "Policy",
"c2jShape" : "PolicyType",
"defaultConsumerFluentSetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #policy(String)}.\n@param policy a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #policy(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@return The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@deprecated Use {@link #policy()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #policy(String)}\n",
"documentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Policy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPolicy",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "policy",
"fluentSetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "policy",
"getterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@return The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Policy",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Policy",
"sensitive" : false,
"setterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).",
"setterMethodName" : "setPolicy",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getDescription",
"beanStyleSetterMethodName" : "setDescription",
"c2jName" : "Description",
"c2jShape" : "DescriptionType",
"defaultConsumerFluentSetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #description(String)}.\n@param description a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #description(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@return A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@deprecated Use {@link #description()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #description(String)}\n",
"documentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Description property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasDescription",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "description",
"fluentSetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "description",
"getterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@return A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Description",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Description",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Description",
"sensitive" : false,
"setterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.",
"setterMethodName" : "setDescription",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyUsage",
"beanStyleSetterMethodName" : "setKeyUsage",
"c2jName" : "KeyUsage",
"c2jShape" : "KeyUsageType",
"defaultConsumerFluentSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyUsageAsString(String)}.\n@param keyUsage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyUsage(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #keyUsageAsString}.\n
\n@return Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@deprecated Use {@link #keyUsageAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType\n@deprecated Use {@link #keyUsage(String)}\n",
"documentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
",
"endpointDiscoveryId" : false,
"enumType" : "KeyUsageType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyUsage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyUsage",
"fluentEnumGetterMethodName" : "keyUsage",
"fluentEnumSetterMethodName" : "keyUsage",
"fluentGetterMethodName" : "keyUsageAsString",
"fluentSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType",
"fluentSetterMethodName" : "keyUsage",
"getterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #keyUsageAsString}.\n
\n@return Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyUsage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyUsage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyUsage",
"sensitive" : false,
"setterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType",
"setterMethodName" : "setKeyUsage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomerMasterKeySpec",
"beanStyleSetterMethodName" : "setCustomerMasterKeySpec",
"c2jName" : "CustomerMasterKeySpec",
"c2jShape" : "CustomerMasterKeySpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customerMasterKeySpecAsString(String)}.\n@param customerMasterKeySpec a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customerMasterKeySpec(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #customerMasterKeySpecAsString}.\n
\n@return Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@deprecated Use {@link #customerMasterKeySpecAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see CustomerMasterKeySpec\n@deprecated Use {@link #customerMasterKeySpec(String)}\n",
"documentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
",
"endpointDiscoveryId" : false,
"enumType" : "CustomerMasterKeySpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomerMasterKeySpec property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomerMasterKeySpec",
"fluentEnumGetterMethodName" : "customerMasterKeySpec",
"fluentEnumSetterMethodName" : "customerMasterKeySpec",
"fluentGetterMethodName" : "customerMasterKeySpecAsString",
"fluentSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see CustomerMasterKeySpec",
"fluentSetterMethodName" : "customerMasterKeySpec",
"getterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #customerMasterKeySpecAsString}.\n
\n@return Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomerMasterKeySpec",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomerMasterKeySpec",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomerMasterKeySpec",
"sensitive" : false,
"setterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec",
"setterMethodName" : "setCustomerMasterKeySpec",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customerMasterKeySpec",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customerMasterKeySpec",
"variableType" : "String",
"documentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getOrigin",
"beanStyleSetterMethodName" : "setOrigin",
"c2jName" : "Origin",
"c2jShape" : "OriginType",
"defaultConsumerFluentSetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #originAsString(String)}.\n@param origin a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #origin(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #origin} will return {@link OriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #originAsString}.\n
\n@return The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@deprecated Use {@link #originAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType\n@deprecated Use {@link #origin(String)}\n",
"documentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : "OriginType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Origin property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasOrigin",
"fluentEnumGetterMethodName" : "origin",
"fluentEnumSetterMethodName" : "origin",
"fluentGetterMethodName" : "originAsString",
"fluentSetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType",
"fluentSetterMethodName" : "origin",
"getterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #origin} will return {@link OriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #originAsString}.\n
\n@return The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Origin",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Origin",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Origin",
"sensitive" : false,
"setterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType",
"setterMethodName" : "setOrigin",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@return Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@return Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getBypassPolicyLockoutSafetyCheck",
"beanStyleSetterMethodName" : "setBypassPolicyLockoutSafetyCheck",
"c2jName" : "BypassPolicyLockoutSafetyCheck",
"c2jShape" : "BooleanType",
"defaultConsumerFluentSetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #bypassPolicyLockoutSafetyCheck(Boolean)}.\n@param bypassPolicyLockoutSafetyCheck a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #bypassPolicyLockoutSafetyCheck(Boolean)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@return A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@deprecated Use {@link #bypassPolicyLockoutSafetyCheck()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #bypassPolicyLockoutSafetyCheck(Boolean)}\n",
"documentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the BypassPolicyLockoutSafetyCheck property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasBypassPolicyLockoutSafetyCheck",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "bypassPolicyLockoutSafetyCheck",
"fluentSetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "bypassPolicyLockoutSafetyCheck",
"getterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@return A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "BypassPolicyLockoutSafetyCheck",
"sensitive" : false,
"setterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.",
"setterMethodName" : "setBypassPolicyLockoutSafetyCheck",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "TagList",
"defaultConsumerFluentSetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "
One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"BypassPolicyLockoutSafetyCheck" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getBypassPolicyLockoutSafetyCheck",
"beanStyleSetterMethodName" : "setBypassPolicyLockoutSafetyCheck",
"c2jName" : "BypassPolicyLockoutSafetyCheck",
"c2jShape" : "BooleanType",
"defaultConsumerFluentSetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #bypassPolicyLockoutSafetyCheck(Boolean)}.\n@param bypassPolicyLockoutSafetyCheck a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #bypassPolicyLockoutSafetyCheck(Boolean)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@return A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@deprecated Use {@link #bypassPolicyLockoutSafetyCheck()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #bypassPolicyLockoutSafetyCheck(Boolean)}\n",
"documentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the BypassPolicyLockoutSafetyCheck property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasBypassPolicyLockoutSafetyCheck",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "bypassPolicyLockoutSafetyCheck",
"fluentSetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "bypassPolicyLockoutSafetyCheck",
"getterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@return A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "BypassPolicyLockoutSafetyCheck",
"sensitive" : false,
"setterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.",
"setterMethodName" : "setBypassPolicyLockoutSafetyCheck",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@return Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@return Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomerMasterKeySpec" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomerMasterKeySpec",
"beanStyleSetterMethodName" : "setCustomerMasterKeySpec",
"c2jName" : "CustomerMasterKeySpec",
"c2jShape" : "CustomerMasterKeySpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customerMasterKeySpecAsString(String)}.\n@param customerMasterKeySpec a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customerMasterKeySpec(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #customerMasterKeySpecAsString}.\n
\n@return Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@deprecated Use {@link #customerMasterKeySpecAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see CustomerMasterKeySpec\n@deprecated Use {@link #customerMasterKeySpec(String)}\n",
"documentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
",
"endpointDiscoveryId" : false,
"enumType" : "CustomerMasterKeySpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomerMasterKeySpec property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomerMasterKeySpec",
"fluentEnumGetterMethodName" : "customerMasterKeySpec",
"fluentEnumSetterMethodName" : "customerMasterKeySpec",
"fluentGetterMethodName" : "customerMasterKeySpecAsString",
"fluentSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see CustomerMasterKeySpec",
"fluentSetterMethodName" : "customerMasterKeySpec",
"getterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #customerMasterKeySpecAsString}.\n
\n@return Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomerMasterKeySpec",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomerMasterKeySpec",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomerMasterKeySpec",
"sensitive" : false,
"setterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec",
"setterMethodName" : "setCustomerMasterKeySpec",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customerMasterKeySpec",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customerMasterKeySpec",
"variableType" : "String",
"documentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Description" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getDescription",
"beanStyleSetterMethodName" : "setDescription",
"c2jName" : "Description",
"c2jShape" : "DescriptionType",
"defaultConsumerFluentSetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #description(String)}.\n@param description a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #description(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@return A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@deprecated Use {@link #description()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #description(String)}\n",
"documentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Description property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasDescription",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "description",
"fluentSetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "description",
"getterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@return A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Description",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Description",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Description",
"sensitive" : false,
"setterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.",
"setterMethodName" : "setDescription",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyUsage" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyUsage",
"beanStyleSetterMethodName" : "setKeyUsage",
"c2jName" : "KeyUsage",
"c2jShape" : "KeyUsageType",
"defaultConsumerFluentSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyUsageAsString(String)}.\n@param keyUsage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyUsage(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #keyUsageAsString}.\n
\n@return Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@deprecated Use {@link #keyUsageAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType\n@deprecated Use {@link #keyUsage(String)}\n",
"documentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
",
"endpointDiscoveryId" : false,
"enumType" : "KeyUsageType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyUsage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyUsage",
"fluentEnumGetterMethodName" : "keyUsage",
"fluentEnumSetterMethodName" : "keyUsage",
"fluentGetterMethodName" : "keyUsageAsString",
"fluentSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType",
"fluentSetterMethodName" : "keyUsage",
"getterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #keyUsageAsString}.\n
\n@return Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyUsage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyUsage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyUsage",
"sensitive" : false,
"setterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType",
"setterMethodName" : "setKeyUsage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Origin" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getOrigin",
"beanStyleSetterMethodName" : "setOrigin",
"c2jName" : "Origin",
"c2jShape" : "OriginType",
"defaultConsumerFluentSetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #originAsString(String)}.\n@param origin a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #origin(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #origin} will return {@link OriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #originAsString}.\n
\n@return The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@deprecated Use {@link #originAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType\n@deprecated Use {@link #origin(String)}\n",
"documentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : "OriginType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Origin property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasOrigin",
"fluentEnumGetterMethodName" : "origin",
"fluentEnumSetterMethodName" : "origin",
"fluentGetterMethodName" : "originAsString",
"fluentSetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType",
"fluentSetterMethodName" : "origin",
"getterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #origin} will return {@link OriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #originAsString}.\n
\n@return The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Origin",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Origin",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Origin",
"sensitive" : false,
"setterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType",
"setterMethodName" : "setOrigin",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Policy" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPolicy",
"beanStyleSetterMethodName" : "setPolicy",
"c2jName" : "Policy",
"c2jShape" : "PolicyType",
"defaultConsumerFluentSetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #policy(String)}.\n@param policy a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #policy(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@return The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@deprecated Use {@link #policy()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #policy(String)}\n",
"documentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Policy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPolicy",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "policy",
"fluentSetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "policy",
"getterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@return The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Policy",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Policy",
"sensitive" : false,
"setterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).",
"setterMethodName" : "setPolicy",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Tags" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "TagList",
"defaultConsumerFluentSetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "
One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPolicy",
"beanStyleSetterMethodName" : "setPolicy",
"c2jName" : "Policy",
"c2jShape" : "PolicyType",
"defaultConsumerFluentSetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #policy(String)}.\n@param policy a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #policy(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@return The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@deprecated Use {@link #policy()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #policy(String)}\n",
"documentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Policy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPolicy",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "policy",
"fluentSetterDocumentation" : "The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "policy",
"getterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@return The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Policy",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Policy",
"sensitive" : false,
"setterDocumentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).",
"setterMethodName" : "setPolicy",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
-
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
-
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getDescription",
"beanStyleSetterMethodName" : "setDescription",
"c2jName" : "Description",
"c2jShape" : "DescriptionType",
"defaultConsumerFluentSetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #description(String)}.\n@param description a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #description(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@return A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@deprecated Use {@link #description()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #description(String)}\n",
"documentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Description property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasDescription",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "description",
"fluentSetterDocumentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "description",
"getterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@return A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Description",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Description",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Description",
"sensitive" : false,
"setterDocumentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
\n@param description A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.",
"setterMethodName" : "setDescription",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyUsage",
"beanStyleSetterMethodName" : "setKeyUsage",
"c2jName" : "KeyUsage",
"c2jShape" : "KeyUsageType",
"defaultConsumerFluentSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyUsageAsString(String)}.\n@param keyUsage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyUsage(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #keyUsageAsString}.\n
\n@return Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@deprecated Use {@link #keyUsageAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType\n@deprecated Use {@link #keyUsage(String)}\n",
"documentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
",
"endpointDiscoveryId" : false,
"enumType" : "KeyUsageType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyUsage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyUsage",
"fluentEnumGetterMethodName" : "keyUsage",
"fluentEnumSetterMethodName" : "keyUsage",
"fluentGetterMethodName" : "keyUsageAsString",
"fluentSetterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType",
"fluentSetterMethodName" : "keyUsage",
"getterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #keyUsage} will return {@link KeyUsageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #keyUsageAsString}.\n
\n@return Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyUsage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyUsage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyUsage",
"sensitive" : false,
"setterDocumentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@param keyUsage Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created. Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
\n@see KeyUsageType",
"setterMethodName" : "setKeyUsage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
Select only one valid value.
-
For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
-
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
-
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomerMasterKeySpec",
"beanStyleSetterMethodName" : "setCustomerMasterKeySpec",
"c2jName" : "CustomerMasterKeySpec",
"c2jShape" : "CustomerMasterKeySpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customerMasterKeySpecAsString(String)}.\n@param customerMasterKeySpec a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customerMasterKeySpec(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #customerMasterKeySpecAsString}.\n
\n@return Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@deprecated Use {@link #customerMasterKeySpecAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see CustomerMasterKeySpec\n@deprecated Use {@link #customerMasterKeySpec(String)}\n",
"documentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
",
"endpointDiscoveryId" : false,
"enumType" : "CustomerMasterKeySpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomerMasterKeySpec property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomerMasterKeySpec",
"fluentEnumGetterMethodName" : "customerMasterKeySpec",
"fluentEnumSetterMethodName" : "customerMasterKeySpec",
"fluentGetterMethodName" : "customerMasterKeySpecAsString",
"fluentSetterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see CustomerMasterKeySpec",
"fluentSetterMethodName" : "customerMasterKeySpec",
"getterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #customerMasterKeySpec} will return {@link CustomerMasterKeySpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #customerMasterKeySpecAsString}.\n
\n@return Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomerMasterKeySpec",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomerMasterKeySpec",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomerMasterKeySpec",
"sensitive" : false,
"setterDocumentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@param customerMasterKeySpec Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide. The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
\n@see CustomerMasterKeySpec",
"setterMethodName" : "setCustomerMasterKeySpec",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customerMasterKeySpec",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customerMasterKeySpec",
"variableType" : "String",
"documentation" : "Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
AWS KMS supports the following key specs for CMKs:
-
Symmetric key (default)
-
SYMMETRIC_DEFAULT (AES-256-GCM)
-
Asymmetric RSA key pairs
-
RSA_2048
-
RSA_3072
-
RSA_4096
-
Asymmetric NIST-recommended elliptic curve key pairs
-
ECC_NIST_P256 (secp256r1)
-
ECC_NIST_P384 (secp384r1)
-
ECC_NIST_P521 (secp521r1)
-
Other asymmetric elliptic curve key pairs
-
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getOrigin",
"beanStyleSetterMethodName" : "setOrigin",
"c2jName" : "Origin",
"c2jShape" : "OriginType",
"defaultConsumerFluentSetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #originAsString(String)}.\n@param origin a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #origin(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #origin} will return {@link OriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #originAsString}.\n
\n@return The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@deprecated Use {@link #originAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType\n@deprecated Use {@link #origin(String)}\n",
"documentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : "OriginType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Origin property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasOrigin",
"fluentEnumGetterMethodName" : "origin",
"fluentEnumSetterMethodName" : "origin",
"fluentGetterMethodName" : "originAsString",
"fluentSetterDocumentation" : "The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType",
"fluentSetterMethodName" : "origin",
"getterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #origin} will return {@link OriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #originAsString}.\n
\n@return The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Origin",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Origin",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Origin",
"sensitive" : false,
"setterDocumentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
\n@param origin The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material. When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.\n@see OriginType",
"setterMethodName" : "setOrigin",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "
The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@return Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@return Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
\n@param customKeyStoreId Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "
Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getBypassPolicyLockoutSafetyCheck",
"beanStyleSetterMethodName" : "setBypassPolicyLockoutSafetyCheck",
"c2jName" : "BypassPolicyLockoutSafetyCheck",
"c2jShape" : "BooleanType",
"defaultConsumerFluentSetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #bypassPolicyLockoutSafetyCheck(Boolean)}.\n@param bypassPolicyLockoutSafetyCheck a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #bypassPolicyLockoutSafetyCheck(Boolean)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@return A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@deprecated Use {@link #bypassPolicyLockoutSafetyCheck()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #bypassPolicyLockoutSafetyCheck(Boolean)}\n",
"documentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the BypassPolicyLockoutSafetyCheck property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasBypassPolicyLockoutSafetyCheck",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "bypassPolicyLockoutSafetyCheck",
"fluentSetterDocumentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "bypassPolicyLockoutSafetyCheck",
"getterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@return A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "BypassPolicyLockoutSafetyCheck",
"sensitive" : false,
"setterDocumentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
\n@param bypassPolicyLockoutSafetyCheck A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.",
"setterMethodName" : "setBypassPolicyLockoutSafetyCheck",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : "
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "TagList",
"defaultConsumerFluentSetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "
One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
\n@param tags One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.
When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CreateKeyRequest",
"simpleMethod" : true,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateKeyRequest",
"variableName" : "createKeyRequest",
"variableType" : "CreateKeyRequest",
"documentation" : null,
"simpleType" : "CreateKeyRequest",
"variableSetterType" : "CreateKeyRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateKeyResponse" : {
"c2jName" : "CreateKeyResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyMetadata",
"beanStyleSetterMethodName" : "setKeyMetadata",
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"defaultConsumerFluentSetterDocumentation" : "Metadata associated with the CMK.
\nThis is a convenience that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to create one manually via {@link KeyMetadata#builder()}.\n\nWhen the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result is passed to {@link #keyMetadata(KeyMetadata)}.\n@param keyMetadata a consumer that will call methods on {@link KeyMetadata.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyMetadata(KeyMetadata)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Metadata associated with the CMK.
\n@return Metadata associated with the CMK.\n@deprecated Use {@link #keyMetadata()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyMetadata(KeyMetadata)}\n",
"documentation" : "Metadata associated with the CMK.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyMetadata",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyMetadata",
"fluentSetterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyMetadata",
"getterDocumentation" : "Metadata associated with the CMK.
\n@return Metadata associated with the CMK.",
"getterModel" : {
"returnType" : "KeyMetadata",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "KeyMetadata",
"sensitive" : false,
"setterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.",
"setterMethodName" : "setKeyMetadata",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : null,
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the CMK.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyMetadata" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyMetadata",
"beanStyleSetterMethodName" : "setKeyMetadata",
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"defaultConsumerFluentSetterDocumentation" : "Metadata associated with the CMK.
\nThis is a convenience that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to create one manually via {@link KeyMetadata#builder()}.\n\nWhen the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result is passed to {@link #keyMetadata(KeyMetadata)}.\n@param keyMetadata a consumer that will call methods on {@link KeyMetadata.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyMetadata(KeyMetadata)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Metadata associated with the CMK.
\n@return Metadata associated with the CMK.\n@deprecated Use {@link #keyMetadata()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyMetadata(KeyMetadata)}\n",
"documentation" : "Metadata associated with the CMK.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyMetadata",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyMetadata",
"fluentSetterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyMetadata",
"getterDocumentation" : "Metadata associated with the CMK.
\n@return Metadata associated with the CMK.",
"getterModel" : {
"returnType" : "KeyMetadata",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "KeyMetadata",
"sensitive" : false,
"setterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.",
"setterMethodName" : "setKeyMetadata",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : null,
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the CMK.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyMetadata",
"beanStyleSetterMethodName" : "setKeyMetadata",
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"defaultConsumerFluentSetterDocumentation" : "Metadata associated with the CMK.
\nThis is a convenience that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to create one manually via {@link KeyMetadata#builder()}.\n\nWhen the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result is passed to {@link #keyMetadata(KeyMetadata)}.\n@param keyMetadata a consumer that will call methods on {@link KeyMetadata.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyMetadata(KeyMetadata)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Metadata associated with the CMK.
\n@return Metadata associated with the CMK.\n@deprecated Use {@link #keyMetadata()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyMetadata(KeyMetadata)}\n",
"documentation" : "Metadata associated with the CMK.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyMetadata",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyMetadata",
"fluentSetterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyMetadata",
"getterDocumentation" : "Metadata associated with the CMK.
\n@return Metadata associated with the CMK.",
"getterModel" : {
"returnType" : "KeyMetadata",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "KeyMetadata",
"sensitive" : false,
"setterDocumentation" : "Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.",
"setterMethodName" : "setKeyMetadata",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : null,
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the CMK.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CreateKeyResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateKeyResponse",
"variableName" : "createKeyResponse",
"variableType" : "CreateKeyResponse",
"documentation" : null,
"simpleType" : "CreateKeyResponse",
"variableSetterType" : "CreateKeyResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CustomKeyStoreHasCmKsException" : {
"c2jName" : "CustomKeyStoreHasCMKsException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. After they are deleted, you can delete the custom key store.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CustomKeyStoreHasCMKsException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CustomKeyStoreHasCmKsException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoreHasCmKsException",
"variableName" : "customKeyStoreHasCmKsException",
"variableType" : "CustomKeyStoreHasCmKsException",
"documentation" : null,
"simpleType" : "CustomKeyStoreHasCmKsException",
"variableSetterType" : "CustomKeyStoreHasCmKsException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CustomKeyStoreInvalidStateException" : {
"c2jName" : "CustomKeyStoreInvalidStateException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
-
You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
-
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
-
You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CustomKeyStoreInvalidStateException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CustomKeyStoreInvalidStateException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoreInvalidStateException",
"variableName" : "customKeyStoreInvalidStateException",
"variableType" : "CustomKeyStoreInvalidStateException",
"documentation" : null,
"simpleType" : "CustomKeyStoreInvalidStateException",
"variableSetterType" : "CustomKeyStoreInvalidStateException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CustomKeyStoreNameInUseException" : {
"c2jName" : "CustomKeyStoreNameInUseException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CustomKeyStoreNameInUseException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CustomKeyStoreNameInUseException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoreNameInUseException",
"variableName" : "customKeyStoreNameInUseException",
"variableType" : "CustomKeyStoreNameInUseException",
"documentation" : null,
"simpleType" : "CustomKeyStoreNameInUseException",
"variableSetterType" : "CustomKeyStoreNameInUseException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CustomKeyStoreNotFoundException" : {
"c2jName" : "CustomKeyStoreNotFoundException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "CustomKeyStoreNotFoundException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CustomKeyStoreNotFoundException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoreNotFoundException",
"variableName" : "customKeyStoreNotFoundException",
"variableType" : "CustomKeyStoreNotFoundException",
"documentation" : null,
"simpleType" : "CustomKeyStoreNotFoundException",
"variableSetterType" : "CustomKeyStoreNotFoundException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CustomKeyStoresListEntry" : {
"c2jName" : "CustomKeyStoresListEntry",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Contains information about each custom key store in the custom key store list.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the custom key store.
\n@return A unique identifier for the custom key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "A unique identifier for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "A unique identifier for the custom key store.
\n@return A unique identifier for the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "A unique identifier for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "The user-specified friendly name for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@return The user-specified friendly name for the custom key store.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "The user-specified friendly name for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "The user-specified friendly name for the custom key store.
\n@return The user-specified friendly name for the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "The user-specified friendly name for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCloudHsmClusterId",
"beanStyleSetterMethodName" : "setCloudHsmClusterId",
"c2jName" : "CloudHsmClusterId",
"c2jShape" : "CloudHsmClusterIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #cloudHsmClusterId(String)}.\n@param cloudHsmClusterId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #cloudHsmClusterId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@return A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@deprecated Use {@link #cloudHsmClusterId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #cloudHsmClusterId(String)}\n",
"documentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CloudHsmClusterId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCloudHsmClusterId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "cloudHsmClusterId",
"fluentSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "cloudHsmClusterId",
"getterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@return A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CloudHsmClusterId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CloudHsmClusterId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CloudHsmClusterId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.",
"setterMethodName" : "setCloudHsmClusterId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTrustAnchorCertificate",
"beanStyleSetterMethodName" : "setTrustAnchorCertificate",
"c2jName" : "TrustAnchorCertificate",
"c2jShape" : "TrustAnchorCertificateType",
"defaultConsumerFluentSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #trustAnchorCertificate(String)}.\n@param trustAnchorCertificate a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #trustAnchorCertificate(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@return The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@deprecated Use {@link #trustAnchorCertificate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #trustAnchorCertificate(String)}\n",
"documentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TrustAnchorCertificate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTrustAnchorCertificate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "trustAnchorCertificate",
"fluentSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "trustAnchorCertificate",
"getterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@return The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TrustAnchorCertificate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TrustAnchorCertificate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TrustAnchorCertificate",
"sensitive" : false,
"setterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.",
"setterMethodName" : "setTrustAnchorCertificate",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConnectionState",
"beanStyleSetterMethodName" : "setConnectionState",
"c2jName" : "ConnectionState",
"c2jShape" : "ConnectionStateType",
"defaultConsumerFluentSetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionStateAsString(String)}.\n@param connectionState a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionState(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionState} will return {@link ConnectionStateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionStateAsString}.\n
\n@return Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@deprecated Use {@link #connectionStateAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionStateType\n@deprecated Use {@link #connectionState(String)}\n",
"documentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : "ConnectionStateType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ConnectionState property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConnectionState",
"fluentEnumGetterMethodName" : "connectionState",
"fluentEnumSetterMethodName" : "connectionState",
"fluentGetterMethodName" : "connectionStateAsString",
"fluentSetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionStateType",
"fluentSetterMethodName" : "connectionState",
"getterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionState} will return {@link ConnectionStateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionStateAsString}.\n
\n@return Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ConnectionState",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ConnectionState",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionState",
"sensitive" : false,
"setterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType",
"setterMethodName" : "setConnectionState",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionState",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionState",
"variableType" : "String",
"documentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConnectionErrorCode",
"beanStyleSetterMethodName" : "setConnectionErrorCode",
"c2jName" : "ConnectionErrorCode",
"c2jShape" : "ConnectionErrorCodeType",
"defaultConsumerFluentSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionErrorCodeAsString(String)}.\n@param connectionErrorCode a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionErrorCode(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionErrorCode} will return {@link ConnectionErrorCodeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionErrorCodeAsString}.\n
\n@return Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@deprecated Use {@link #connectionErrorCodeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionErrorCodeType\n@deprecated Use {@link #connectionErrorCode(String)}\n",
"documentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : "ConnectionErrorCodeType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ConnectionErrorCode property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConnectionErrorCode",
"fluentEnumGetterMethodName" : "connectionErrorCode",
"fluentEnumSetterMethodName" : "connectionErrorCode",
"fluentGetterMethodName" : "connectionErrorCodeAsString",
"fluentSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionErrorCodeType",
"fluentSetterMethodName" : "connectionErrorCode",
"getterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionErrorCode} will return {@link ConnectionErrorCodeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionErrorCodeAsString}.\n
\n@return Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ConnectionErrorCode",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ConnectionErrorCode",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionErrorCode",
"sensitive" : false,
"setterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType",
"setterMethodName" : "setConnectionErrorCode",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionErrorCode",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionErrorCode",
"variableType" : "String",
"documentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCreationDate",
"beanStyleSetterMethodName" : "setCreationDate",
"c2jName" : "CreationDate",
"c2jShape" : "DateType",
"defaultConsumerFluentSetterDocumentation" : "The date and time when the custom key store was created.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #creationDate(Instant)}.\n@param creationDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #creationDate(Instant)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The date and time when the custom key store was created.
\n@return The date and time when the custom key store was created.\n@deprecated Use {@link #creationDate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #creationDate(Instant)}\n",
"documentation" : "The date and time when the custom key store was created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CreationDate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCreationDate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "creationDate",
"fluentSetterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "creationDate",
"getterDocumentation" : "The date and time when the custom key store was created.
\n@return The date and time when the custom key store was created.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CreationDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CreationDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "CreationDate",
"sensitive" : false,
"setterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.",
"setterMethodName" : "setCreationDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "creationDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "creationDate",
"variableType" : "java.time.Instant",
"documentation" : "The date and time when the custom key store was created.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CloudHsmClusterId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCloudHsmClusterId",
"beanStyleSetterMethodName" : "setCloudHsmClusterId",
"c2jName" : "CloudHsmClusterId",
"c2jShape" : "CloudHsmClusterIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #cloudHsmClusterId(String)}.\n@param cloudHsmClusterId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #cloudHsmClusterId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@return A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@deprecated Use {@link #cloudHsmClusterId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #cloudHsmClusterId(String)}\n",
"documentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CloudHsmClusterId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCloudHsmClusterId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "cloudHsmClusterId",
"fluentSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "cloudHsmClusterId",
"getterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@return A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CloudHsmClusterId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CloudHsmClusterId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CloudHsmClusterId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.",
"setterMethodName" : "setCloudHsmClusterId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"ConnectionErrorCode" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConnectionErrorCode",
"beanStyleSetterMethodName" : "setConnectionErrorCode",
"c2jName" : "ConnectionErrorCode",
"c2jShape" : "ConnectionErrorCodeType",
"defaultConsumerFluentSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionErrorCodeAsString(String)}.\n@param connectionErrorCode a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionErrorCode(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionErrorCode} will return {@link ConnectionErrorCodeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionErrorCodeAsString}.\n
\n@return Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@deprecated Use {@link #connectionErrorCodeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionErrorCodeType\n@deprecated Use {@link #connectionErrorCode(String)}\n",
"documentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : "ConnectionErrorCodeType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ConnectionErrorCode property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConnectionErrorCode",
"fluentEnumGetterMethodName" : "connectionErrorCode",
"fluentEnumSetterMethodName" : "connectionErrorCode",
"fluentGetterMethodName" : "connectionErrorCodeAsString",
"fluentSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionErrorCodeType",
"fluentSetterMethodName" : "connectionErrorCode",
"getterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionErrorCode} will return {@link ConnectionErrorCodeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionErrorCodeAsString}.\n
\n@return Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ConnectionErrorCode",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ConnectionErrorCode",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionErrorCode",
"sensitive" : false,
"setterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType",
"setterMethodName" : "setConnectionErrorCode",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionErrorCode",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionErrorCode",
"variableType" : "String",
"documentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"ConnectionState" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConnectionState",
"beanStyleSetterMethodName" : "setConnectionState",
"c2jName" : "ConnectionState",
"c2jShape" : "ConnectionStateType",
"defaultConsumerFluentSetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionStateAsString(String)}.\n@param connectionState a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionState(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionState} will return {@link ConnectionStateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionStateAsString}.\n
\n@return Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@deprecated Use {@link #connectionStateAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionStateType\n@deprecated Use {@link #connectionState(String)}\n",
"documentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : "ConnectionStateType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ConnectionState property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConnectionState",
"fluentEnumGetterMethodName" : "connectionState",
"fluentEnumSetterMethodName" : "connectionState",
"fluentGetterMethodName" : "connectionStateAsString",
"fluentSetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionStateType",
"fluentSetterMethodName" : "connectionState",
"getterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionState} will return {@link ConnectionStateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionStateAsString}.\n
\n@return Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ConnectionState",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ConnectionState",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionState",
"sensitive" : false,
"setterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType",
"setterMethodName" : "setConnectionState",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionState",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionState",
"variableType" : "String",
"documentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CreationDate" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCreationDate",
"beanStyleSetterMethodName" : "setCreationDate",
"c2jName" : "CreationDate",
"c2jShape" : "DateType",
"defaultConsumerFluentSetterDocumentation" : "The date and time when the custom key store was created.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #creationDate(Instant)}.\n@param creationDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #creationDate(Instant)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The date and time when the custom key store was created.
\n@return The date and time when the custom key store was created.\n@deprecated Use {@link #creationDate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #creationDate(Instant)}\n",
"documentation" : "The date and time when the custom key store was created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CreationDate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCreationDate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "creationDate",
"fluentSetterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "creationDate",
"getterDocumentation" : "The date and time when the custom key store was created.
\n@return The date and time when the custom key store was created.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CreationDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CreationDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "CreationDate",
"sensitive" : false,
"setterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.",
"setterMethodName" : "setCreationDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "creationDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "creationDate",
"variableType" : "java.time.Instant",
"documentation" : "The date and time when the custom key store was created.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the custom key store.
\n@return A unique identifier for the custom key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "A unique identifier for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "A unique identifier for the custom key store.
\n@return A unique identifier for the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "A unique identifier for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomKeyStoreName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "The user-specified friendly name for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@return The user-specified friendly name for the custom key store.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "The user-specified friendly name for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "The user-specified friendly name for the custom key store.
\n@return The user-specified friendly name for the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "The user-specified friendly name for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"TrustAnchorCertificate" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTrustAnchorCertificate",
"beanStyleSetterMethodName" : "setTrustAnchorCertificate",
"c2jName" : "TrustAnchorCertificate",
"c2jShape" : "TrustAnchorCertificateType",
"defaultConsumerFluentSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #trustAnchorCertificate(String)}.\n@param trustAnchorCertificate a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #trustAnchorCertificate(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@return The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@deprecated Use {@link #trustAnchorCertificate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #trustAnchorCertificate(String)}\n",
"documentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TrustAnchorCertificate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTrustAnchorCertificate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "trustAnchorCertificate",
"fluentSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "trustAnchorCertificate",
"getterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@return The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TrustAnchorCertificate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TrustAnchorCertificate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TrustAnchorCertificate",
"sensitive" : false,
"setterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.",
"setterMethodName" : "setTrustAnchorCertificate",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the custom key store.
\n@return A unique identifier for the custom key store.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "A unique identifier for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "A unique identifier for the custom key store.
\n@return A unique identifier for the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the custom key store.
\n@param customKeyStoreId A unique identifier for the custom key store.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "A unique identifier for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "The user-specified friendly name for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@return The user-specified friendly name for the custom key store.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "The user-specified friendly name for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "The user-specified friendly name for the custom key store.
\n@return The user-specified friendly name for the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "The user-specified friendly name for the custom key store.
\n@param customKeyStoreName The user-specified friendly name for the custom key store.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "The user-specified friendly name for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCloudHsmClusterId",
"beanStyleSetterMethodName" : "setCloudHsmClusterId",
"c2jName" : "CloudHsmClusterId",
"c2jShape" : "CloudHsmClusterIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #cloudHsmClusterId(String)}.\n@param cloudHsmClusterId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #cloudHsmClusterId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@return A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@deprecated Use {@link #cloudHsmClusterId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #cloudHsmClusterId(String)}\n",
"documentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CloudHsmClusterId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCloudHsmClusterId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "cloudHsmClusterId",
"fluentSetterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "cloudHsmClusterId",
"getterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@return A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CloudHsmClusterId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CloudHsmClusterId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CloudHsmClusterId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
\n@param cloudHsmClusterId A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.",
"setterMethodName" : "setCloudHsmClusterId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "cloudHsmClusterId",
"variableType" : "String",
"documentation" : "A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTrustAnchorCertificate",
"beanStyleSetterMethodName" : "setTrustAnchorCertificate",
"c2jName" : "TrustAnchorCertificate",
"c2jShape" : "TrustAnchorCertificateType",
"defaultConsumerFluentSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #trustAnchorCertificate(String)}.\n@param trustAnchorCertificate a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #trustAnchorCertificate(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@return The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@deprecated Use {@link #trustAnchorCertificate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #trustAnchorCertificate(String)}\n",
"documentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the TrustAnchorCertificate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTrustAnchorCertificate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "trustAnchorCertificate",
"fluentSetterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "trustAnchorCertificate",
"getterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@return The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "TrustAnchorCertificate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "TrustAnchorCertificate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "TrustAnchorCertificate",
"sensitive" : false,
"setterDocumentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
\n@param trustAnchorCertificate The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.",
"setterMethodName" : "setTrustAnchorCertificate",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "trustAnchorCertificate",
"variableType" : "String",
"documentation" : "The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConnectionState",
"beanStyleSetterMethodName" : "setConnectionState",
"c2jName" : "ConnectionState",
"c2jShape" : "ConnectionStateType",
"defaultConsumerFluentSetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionStateAsString(String)}.\n@param connectionState a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionState(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionState} will return {@link ConnectionStateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionStateAsString}.\n
\n@return Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@deprecated Use {@link #connectionStateAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionStateType\n@deprecated Use {@link #connectionState(String)}\n",
"documentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : "ConnectionStateType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ConnectionState property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConnectionState",
"fluentEnumGetterMethodName" : "connectionState",
"fluentEnumSetterMethodName" : "connectionState",
"fluentGetterMethodName" : "connectionStateAsString",
"fluentSetterDocumentation" : "Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionStateType",
"fluentSetterMethodName" : "connectionState",
"getterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionState} will return {@link ConnectionStateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionStateAsString}.\n
\n@return Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ConnectionState",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ConnectionState",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionState",
"sensitive" : false,
"setterDocumentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
\n@param connectionState Indicates whether the custom key store is connected to its AWS CloudHSM cluster. You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.\n@see ConnectionStateType",
"setterMethodName" : "setConnectionState",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionState",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionState",
"variableType" : "String",
"documentation" : "
Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getConnectionErrorCode",
"beanStyleSetterMethodName" : "setConnectionErrorCode",
"c2jName" : "ConnectionErrorCode",
"c2jShape" : "ConnectionErrorCodeType",
"defaultConsumerFluentSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionErrorCodeAsString(String)}.\n@param connectionErrorCode a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionErrorCode(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionErrorCode} will return {@link ConnectionErrorCodeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionErrorCodeAsString}.\n
\n@return Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@deprecated Use {@link #connectionErrorCodeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionErrorCodeType\n@deprecated Use {@link #connectionErrorCode(String)}\n",
"documentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : "ConnectionErrorCodeType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ConnectionErrorCode property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasConnectionErrorCode",
"fluentEnumGetterMethodName" : "connectionErrorCode",
"fluentEnumSetterMethodName" : "connectionErrorCode",
"fluentGetterMethodName" : "connectionErrorCodeAsString",
"fluentSetterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType\n@return Returns a reference to this object so that method calls can be chained together.\n@see ConnectionErrorCodeType",
"fluentSetterMethodName" : "connectionErrorCode",
"getterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #connectionErrorCode} will return {@link ConnectionErrorCodeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #connectionErrorCodeAsString}.\n
\n@return Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ConnectionErrorCode",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ConnectionErrorCode",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionErrorCode",
"sensitive" : false,
"setterDocumentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@param connectionErrorCode Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide. Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
\n@see ConnectionErrorCodeType",
"setterMethodName" : "setConnectionErrorCode",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionErrorCode",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionErrorCode",
"variableType" : "String",
"documentation" : "Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.
Valid values are:
-
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
-
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
-
INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
-
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
-
SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the AWS Key Management Service Developer Guide.
-
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
-
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the AWS Key Management Service Developer Guide.
-
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCreationDate",
"beanStyleSetterMethodName" : "setCreationDate",
"c2jName" : "CreationDate",
"c2jShape" : "DateType",
"defaultConsumerFluentSetterDocumentation" : "The date and time when the custom key store was created.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #creationDate(Instant)}.\n@param creationDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #creationDate(Instant)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The date and time when the custom key store was created.
\n@return The date and time when the custom key store was created.\n@deprecated Use {@link #creationDate()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #creationDate(Instant)}\n",
"documentation" : "The date and time when the custom key store was created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CreationDate property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCreationDate",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "creationDate",
"fluentSetterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "creationDate",
"getterDocumentation" : "The date and time when the custom key store was created.
\n@return The date and time when the custom key store was created.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CreationDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CreationDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "CreationDate",
"sensitive" : false,
"setterDocumentation" : "The date and time when the custom key store was created.
\n@param creationDate The date and time when the custom key store was created.",
"setterMethodName" : "setCreationDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "creationDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "creationDate",
"variableType" : "java.time.Instant",
"documentation" : "The date and time when the custom key store was created.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CustomKeyStoresListEntry",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "customKeyStoresListEntry",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : null,
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CustomerMasterKeySpec" : {
"c2jName" : "CustomerMasterKeySpec",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "RSA_2048",
"value" : "RSA_2048"
}, {
"name" : "RSA_3072",
"value" : "RSA_3072"
}, {
"name" : "RSA_4096",
"value" : "RSA_4096"
}, {
"name" : "ECC_NIST_P256",
"value" : "ECC_NIST_P256"
}, {
"name" : "ECC_NIST_P384",
"value" : "ECC_NIST_P384"
}, {
"name" : "ECC_NIST_P521",
"value" : "ECC_NIST_P521"
}, {
"name" : "ECC_SECG_P256_K1",
"value" : "ECC_SECG_P256K1"
}, {
"name" : "SYMMETRIC_DEFAULT",
"value" : "SYMMETRIC_DEFAULT"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CustomerMasterKeySpec",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CustomerMasterKeySpec",
"variableName" : "customerMasterKeySpec",
"variableType" : "CustomerMasterKeySpec",
"documentation" : null,
"simpleType" : "CustomerMasterKeySpec",
"variableSetterType" : "CustomerMasterKeySpec"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DataKeyPairSpec" : {
"c2jName" : "DataKeyPairSpec",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "RSA_2048",
"value" : "RSA_2048"
}, {
"name" : "RSA_3072",
"value" : "RSA_3072"
}, {
"name" : "RSA_4096",
"value" : "RSA_4096"
}, {
"name" : "ECC_NIST_P256",
"value" : "ECC_NIST_P256"
}, {
"name" : "ECC_NIST_P384",
"value" : "ECC_NIST_P384"
}, {
"name" : "ECC_NIST_P521",
"value" : "ECC_NIST_P521"
}, {
"name" : "ECC_SECG_P256_K1",
"value" : "ECC_SECG_P256K1"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DataKeyPairSpec",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DataKeyPairSpec",
"variableName" : "dataKeyPairSpec",
"variableType" : "DataKeyPairSpec",
"documentation" : null,
"simpleType" : "DataKeyPairSpec",
"variableSetterType" : "DataKeyPairSpec"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DataKeySpec" : {
"c2jName" : "DataKeySpec",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "AES_256",
"value" : "AES_256"
}, {
"name" : "AES_128",
"value" : "AES_128"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DataKeySpec",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DataKeySpec",
"variableName" : "dataKeySpec",
"variableType" : "DataKeySpec",
"documentation" : null,
"simpleType" : "DataKeySpec",
"variableSetterType" : "DataKeySpec"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DecryptRequest" : {
"c2jName" : "DecryptRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "Decrypt",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.Decrypt",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCiphertextBlob",
"beanStyleSetterMethodName" : "setCiphertextBlob",
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"defaultConsumerFluentSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #ciphertextBlob(SdkBytes)}.\n@param ciphertextBlob a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #ciphertextBlob(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@return Ciphertext to be decrypted. The blob includes metadata.\n@deprecated Use {@link #ciphertextBlob()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #ciphertextBlob(SdkBytes)}\n",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CiphertextBlob property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCiphertextBlob",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "ciphertextBlob",
"fluentSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "ciphertextBlob",
"getterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@return Ciphertext to be decrypted. The blob includes metadata.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "CiphertextBlob",
"sensitive" : false,
"setterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.",
"setterMethodName" : "setCiphertextBlob",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "ciphertextBlob",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "ciphertextBlob",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getEncryptionContext",
"beanStyleSetterMethodName" : "setEncryptionContext",
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #encryptionContext(Map)}.\n@param encryptionContext a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionContext(Map)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #encryptionContext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #encryptionContext(Map)}\n",
"documentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionContext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "encryptionContext",
"fluentSetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "encryptionContext",
"getterDocumentation" : "
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "EncryptionContextKey",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.\n@deprecated Use {@link #key()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #key(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.\n@deprecated Use {@link #value()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #value(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Value property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasValue",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "EncryptionContext",
"sensitive" : false,
"setterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setEncryptionContext",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CiphertextBlob" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCiphertextBlob",
"beanStyleSetterMethodName" : "setCiphertextBlob",
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"defaultConsumerFluentSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #ciphertextBlob(SdkBytes)}.\n@param ciphertextBlob a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #ciphertextBlob(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@return Ciphertext to be decrypted. The blob includes metadata.\n@deprecated Use {@link #ciphertextBlob()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #ciphertextBlob(SdkBytes)}\n",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CiphertextBlob property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCiphertextBlob",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "ciphertextBlob",
"fluentSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "ciphertextBlob",
"getterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@return Ciphertext to be decrypted. The blob includes metadata.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "CiphertextBlob",
"sensitive" : false,
"setterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.",
"setterMethodName" : "setCiphertextBlob",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "ciphertextBlob",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "ciphertextBlob",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"EncryptionAlgorithm" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"EncryptionContext" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getEncryptionContext",
"beanStyleSetterMethodName" : "setEncryptionContext",
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #encryptionContext(Map)}.\n@param encryptionContext a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionContext(Map)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #encryptionContext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #encryptionContext(Map)}\n",
"documentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionContext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "encryptionContext",
"fluentSetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "encryptionContext",
"getterDocumentation" : "
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "EncryptionContextKey",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.\n@deprecated Use {@link #key()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #key(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.\n@deprecated Use {@link #value()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #value(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Value property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasValue",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "EncryptionContext",
"sensitive" : false,
"setterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setEncryptionContext",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"GrantTokens" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCiphertextBlob",
"beanStyleSetterMethodName" : "setCiphertextBlob",
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"defaultConsumerFluentSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #ciphertextBlob(SdkBytes)}.\n@param ciphertextBlob a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #ciphertextBlob(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@return Ciphertext to be decrypted. The blob includes metadata.\n@deprecated Use {@link #ciphertextBlob()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #ciphertextBlob(SdkBytes)}\n",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CiphertextBlob property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCiphertextBlob",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "ciphertextBlob",
"fluentSetterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "ciphertextBlob",
"getterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@return Ciphertext to be decrypted. The blob includes metadata.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "CiphertextBlob",
"sensitive" : false,
"setterDocumentation" : "Ciphertext to be decrypted. The blob includes metadata.
\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.",
"setterMethodName" : "setCiphertextBlob",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "ciphertextBlob",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "ciphertextBlob",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getEncryptionContext",
"beanStyleSetterMethodName" : "setEncryptionContext",
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #encryptionContext(Map)}.\n@param encryptionContext a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionContext(Map)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #encryptionContext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #encryptionContext(Map)}\n",
"documentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionContext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "encryptionContext",
"fluentSetterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "encryptionContext",
"getterDocumentation" : "
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "EncryptionContextKey",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.\n@deprecated Use {@link #key()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #key(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.\n@deprecated Use {@link #value()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #value(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Value property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasValue",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "EncryptionContext",
"sensitive" : false,
"setterDocumentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setEncryptionContext",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext. If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
\n@param encryptionAlgorithm Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails. This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "
Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "CiphertextBlob" ],
"shapeName" : "DecryptRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DecryptRequest",
"variableName" : "decryptRequest",
"variableType" : "DecryptRequest",
"documentation" : null,
"simpleType" : "DecryptRequest",
"variableSetterType" : "DecryptRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DecryptResponse" : {
"c2jName" : "DecryptResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@return The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@return The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPlaintext",
"beanStyleSetterMethodName" : "setPlaintext",
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"defaultConsumerFluentSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #plaintext(SdkBytes)}.\n@param plaintext a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #plaintext(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@return Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@deprecated Use {@link #plaintext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #plaintext(SdkBytes)}\n",
"documentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Plaintext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPlaintext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "plaintext",
"fluentSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "plaintext",
"getterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@return Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Plaintext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Plaintext",
"sensitive" : true,
"setterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.",
"setterMethodName" : "setPlaintext",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "The encryption algorithm that was used to decrypt the ciphertext.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "The encryption algorithm that was used to decrypt the ciphertext.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"EncryptionAlgorithm" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "The encryption algorithm that was used to decrypt the ciphertext.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "The encryption algorithm that was used to decrypt the ciphertext.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@return The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@return The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Plaintext" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPlaintext",
"beanStyleSetterMethodName" : "setPlaintext",
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"defaultConsumerFluentSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #plaintext(SdkBytes)}.\n@param plaintext a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #plaintext(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@return Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@deprecated Use {@link #plaintext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #plaintext(SdkBytes)}\n",
"documentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Plaintext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPlaintext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "plaintext",
"fluentSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "plaintext",
"getterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@return Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Plaintext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Plaintext",
"sensitive" : true,
"setterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.",
"setterMethodName" : "setPlaintext",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@return The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@return The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
\n@param keyId The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPlaintext",
"beanStyleSetterMethodName" : "setPlaintext",
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"defaultConsumerFluentSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #plaintext(SdkBytes)}.\n@param plaintext a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #plaintext(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@return Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@deprecated Use {@link #plaintext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #plaintext(SdkBytes)}\n",
"documentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Plaintext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPlaintext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "plaintext",
"fluentSetterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "plaintext",
"getterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@return Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Plaintext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Plaintext",
"sensitive" : true,
"setterDocumentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
\n@param plaintext Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.",
"setterMethodName" : "setPlaintext",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "The encryption algorithm that was used to decrypt the ciphertext.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "The encryption algorithm that was used to decrypt the ciphertext.
\n@param encryptionAlgorithm The encryption algorithm that was used to decrypt the ciphertext.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "The encryption algorithm that was used to decrypt the ciphertext.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DecryptResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DecryptResponse",
"variableName" : "decryptResponse",
"variableType" : "DecryptResponse",
"documentation" : null,
"simpleType" : "DecryptResponse",
"variableSetterType" : "DecryptResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteAliasRequest" : {
"c2jName" : "DeleteAliasRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DeleteAlias",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DeleteAlias",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@return The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@return The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AliasName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@return The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@return The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getAliasName",
"beanStyleSetterMethodName" : "setAliasName",
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"defaultConsumerFluentSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #aliasName(String)}.\n@param aliasName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #aliasName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@return The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@deprecated Use {@link #aliasName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #aliasName(String)}\n",
"documentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the AliasName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasAliasName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "aliasName",
"fluentSetterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "aliasName",
"getterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@return The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "AliasName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AliasName",
"sensitive" : false,
"setterDocumentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
\n@param aliasName The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.",
"setterMethodName" : "setAliasName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "AliasName" ],
"shapeName" : "DeleteAliasRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteAliasRequest",
"variableName" : "deleteAliasRequest",
"variableType" : "DeleteAliasRequest",
"documentation" : null,
"simpleType" : "DeleteAliasRequest",
"variableSetterType" : "DeleteAliasRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteAliasResponse" : {
"c2jName" : "DeleteAliasResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DeleteAliasResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteAliasResponse",
"variableName" : "deleteAliasResponse",
"variableType" : "DeleteAliasResponse",
"documentation" : null,
"simpleType" : "DeleteAliasResponse",
"variableSetterType" : "DeleteAliasResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteCustomKeyStoreRequest" : {
"c2jName" : "DeleteCustomKeyStoreRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DeleteCustomKeyStore",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DeleteCustomKeyStore",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "CustomKeyStoreId" ],
"shapeName" : "DeleteCustomKeyStoreRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteCustomKeyStoreRequest",
"variableName" : "deleteCustomKeyStoreRequest",
"variableType" : "DeleteCustomKeyStoreRequest",
"documentation" : null,
"simpleType" : "DeleteCustomKeyStoreRequest",
"variableSetterType" : "DeleteCustomKeyStoreRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteCustomKeyStoreResponse" : {
"c2jName" : "DeleteCustomKeyStoreResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DeleteCustomKeyStoreResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteCustomKeyStoreResponse",
"variableName" : "deleteCustomKeyStoreResponse",
"variableType" : "DeleteCustomKeyStoreResponse",
"documentation" : null,
"simpleType" : "DeleteCustomKeyStoreResponse",
"variableSetterType" : "DeleteCustomKeyStoreResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteImportedKeyMaterialRequest" : {
"c2jName" : "DeleteImportedKeyMaterialRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DeleteImportedKeyMaterial",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DeleteImportedKeyMaterial",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "DeleteImportedKeyMaterialRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteImportedKeyMaterialRequest",
"variableName" : "deleteImportedKeyMaterialRequest",
"variableType" : "DeleteImportedKeyMaterialRequest",
"documentation" : null,
"simpleType" : "DeleteImportedKeyMaterialRequest",
"variableSetterType" : "DeleteImportedKeyMaterialRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteImportedKeyMaterialResponse" : {
"c2jName" : "DeleteImportedKeyMaterialResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DeleteImportedKeyMaterialResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteImportedKeyMaterialResponse",
"variableName" : "deleteImportedKeyMaterialResponse",
"variableType" : "DeleteImportedKeyMaterialResponse",
"documentation" : null,
"simpleType" : "DeleteImportedKeyMaterialResponse",
"variableSetterType" : "DeleteImportedKeyMaterialResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DependencyTimeoutException" : {
"c2jName" : "DependencyTimeoutException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "DependencyTimeoutException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DependencyTimeoutException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DependencyTimeoutException",
"variableName" : "dependencyTimeoutException",
"variableType" : "DependencyTimeoutException",
"documentation" : null,
"simpleType" : "DependencyTimeoutException",
"variableSetterType" : "DependencyTimeoutException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeCustomKeyStoresRequest" : {
"c2jName" : "DescribeCustomKeyStoresRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DescribeCustomKeyStores",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DescribeCustomKeyStores",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLimit",
"beanStyleSetterMethodName" : "setLimit",
"c2jName" : "Limit",
"c2jShape" : "LimitType",
"defaultConsumerFluentSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #limit(Integer)}.\n@param limit a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #limit(Integer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@deprecated Use {@link #limit()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #limit(Integer)}\n",
"documentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Limit property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLimit",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "limit",
"fluentSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "limit",
"getterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Limit",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Limit",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "Limit",
"sensitive" : false,
"setterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.",
"setterMethodName" : "setLimit",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "limit",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "limit",
"variableType" : "Integer",
"documentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMarker",
"beanStyleSetterMethodName" : "setMarker",
"c2jName" : "Marker",
"c2jShape" : "MarkerType",
"defaultConsumerFluentSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #marker(String)}.\n@param marker a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #marker(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@deprecated Use {@link #marker()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #marker(String)}\n",
"documentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Marker property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMarker",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "marker",
"fluentSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "marker",
"getterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Marker",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Marker",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Marker",
"sensitive" : false,
"setterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.",
"setterMethodName" : "setMarker",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "marker",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "marker",
"variableType" : "String",
"documentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomKeyStoreName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Limit" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLimit",
"beanStyleSetterMethodName" : "setLimit",
"c2jName" : "Limit",
"c2jShape" : "LimitType",
"defaultConsumerFluentSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #limit(Integer)}.\n@param limit a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #limit(Integer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@deprecated Use {@link #limit()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #limit(Integer)}\n",
"documentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Limit property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLimit",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "limit",
"fluentSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "limit",
"getterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Limit",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Limit",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "Limit",
"sensitive" : false,
"setterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.",
"setterMethodName" : "setLimit",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "limit",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "limit",
"variableType" : "Integer",
"documentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Marker" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMarker",
"beanStyleSetterMethodName" : "setMarker",
"c2jName" : "Marker",
"c2jShape" : "MarkerType",
"defaultConsumerFluentSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #marker(String)}.\n@param marker a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #marker(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@deprecated Use {@link #marker()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #marker(String)}\n",
"documentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Marker property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMarker",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "marker",
"fluentSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "marker",
"getterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Marker",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Marker",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Marker",
"sensitive" : false,
"setterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.",
"setterMethodName" : "setMarker",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "marker",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "marker",
"variableType" : "String",
"documentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreId Gets only information about the specified custom key store. Enter the key store ID. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreName",
"beanStyleSetterMethodName" : "setCustomKeyStoreName",
"c2jName" : "CustomKeyStoreName",
"c2jShape" : "CustomKeyStoreNameType",
"defaultConsumerFluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreName(String)}.\n@param customKeyStoreName a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@deprecated Use {@link #customKeyStoreName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreName(String)}\n",
"documentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreName",
"fluentSetterDocumentation" : "Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreName",
"getterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@return Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreName",
"sensitive" : false,
"setterDocumentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
\n@param customKeyStoreName Gets only information about the specified custom key store. Enter the friendly name of the custom key store. By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.",
"setterMethodName" : "setCustomKeyStoreName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreName",
"variableType" : "String",
"documentation" : "
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLimit",
"beanStyleSetterMethodName" : "setLimit",
"c2jName" : "Limit",
"c2jShape" : "LimitType",
"defaultConsumerFluentSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #limit(Integer)}.\n@param limit a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #limit(Integer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@deprecated Use {@link #limit()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #limit(Integer)}\n",
"documentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Limit property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLimit",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "limit",
"fluentSetterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "limit",
"getterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Limit",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Limit",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "Limit",
"sensitive" : false,
"setterDocumentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
\n@param limit Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.",
"setterMethodName" : "setLimit",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "limit",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "limit",
"variableType" : "Integer",
"documentation" : "Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMarker",
"beanStyleSetterMethodName" : "setMarker",
"c2jName" : "Marker",
"c2jShape" : "MarkerType",
"defaultConsumerFluentSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #marker(String)}.\n@param marker a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #marker(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@deprecated Use {@link #marker()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #marker(String)}\n",
"documentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Marker property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMarker",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "marker",
"fluentSetterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "marker",
"getterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Marker",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Marker",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Marker",
"sensitive" : false,
"setterDocumentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
\n@param marker Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.",
"setterMethodName" : "setMarker",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "marker",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "marker",
"variableType" : "String",
"documentation" : "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DescribeCustomKeyStoresRequest",
"simpleMethod" : true,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DescribeCustomKeyStoresRequest",
"variableName" : "describeCustomKeyStoresRequest",
"variableType" : "DescribeCustomKeyStoresRequest",
"documentation" : null,
"simpleType" : "DescribeCustomKeyStoresRequest",
"variableSetterType" : "DescribeCustomKeyStoresRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeCustomKeyStoresResponse" : {
"c2jName" : "DescribeCustomKeyStoresResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getCustomKeyStores",
"beanStyleSetterMethodName" : "setCustomKeyStores",
"c2jName" : "CustomKeyStores",
"c2jShape" : "CustomKeyStoresList",
"defaultConsumerFluentSetterDocumentation" : "Contains metadata about each custom key store.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #customKeyStores(List)}.\n@param customKeyStores a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStores(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Contains metadata about each custom key store.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasCustomKeyStores()} to see if a value was sent in this field.\n
\n@return Contains metadata about each custom key store.\n@deprecated Use {@link #customKeyStores()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStores(List)}\n",
"documentation" : "Contains metadata about each custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStores property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStores",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStores",
"fluentSetterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStores",
"getterDocumentation" : "Contains metadata about each custom key store.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasCustomKeyStores()} to see if a value was sent in this field.\n
\n@return Contains metadata about each custom key store.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStores",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStores",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "CustomKeyStoresListEntry",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link CustomKeyStoresListEntry.Builder} avoiding the need to create one manually via {@link CustomKeyStoresListEntry#builder()}.\n\nWhen the {@link Consumer} completes, {@link CustomKeyStoresListEntry.Builder#build()} is called immediately and its result is passed to {@link #member(CustomKeyStoresListEntry)}.\n@param member a consumer that will call methods on {@link CustomKeyStoresListEntry.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(CustomKeyStoresListEntry)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(CustomKeyStoresListEntry)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "CustomKeyStoresListEntry",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "member",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : null,
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "member",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : "",
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "CustomKeyStoresListEntry",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "CustomKeyStoresListEntry",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "CustomKeyStores",
"sensitive" : false,
"setterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.",
"setterMethodName" : "setCustomKeyStores",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customKeyStores",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customKeyStores",
"variableType" : "java.util.List",
"documentation" : "Contains metadata about each custom key store.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getNextMarker",
"beanStyleSetterMethodName" : "setNextMarker",
"c2jName" : "NextMarker",
"c2jShape" : "MarkerType",
"defaultConsumerFluentSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #nextMarker(String)}.\n@param nextMarker a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #nextMarker(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@return When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@deprecated Use {@link #nextMarker()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #nextMarker(String)}\n",
"documentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the NextMarker property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasNextMarker",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "nextMarker",
"fluentSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "nextMarker",
"getterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@return When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "NextMarker",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "NextMarker",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "NextMarker",
"sensitive" : false,
"setterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.",
"setterMethodName" : "setNextMarker",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "nextMarker",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "nextMarker",
"variableType" : "String",
"documentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTruncated",
"beanStyleSetterMethodName" : "setTruncated",
"c2jName" : "Truncated",
"c2jShape" : "BooleanType",
"defaultConsumerFluentSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #truncated(Boolean)}.\n@param truncated a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #truncated(Boolean)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@return A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@deprecated Use {@link #truncated()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #truncated(Boolean)}\n",
"documentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Truncated property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTruncated",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "truncated",
"fluentSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "truncated",
"getterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@return A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Truncated",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Truncated",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "Truncated",
"sensitive" : false,
"setterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.",
"setterMethodName" : "setTruncated",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "truncated",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "truncated",
"variableType" : "Boolean",
"documentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomKeyStores" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getCustomKeyStores",
"beanStyleSetterMethodName" : "setCustomKeyStores",
"c2jName" : "CustomKeyStores",
"c2jShape" : "CustomKeyStoresList",
"defaultConsumerFluentSetterDocumentation" : "Contains metadata about each custom key store.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #customKeyStores(List)}.\n@param customKeyStores a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStores(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Contains metadata about each custom key store.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasCustomKeyStores()} to see if a value was sent in this field.\n
\n@return Contains metadata about each custom key store.\n@deprecated Use {@link #customKeyStores()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStores(List)}\n",
"documentation" : "Contains metadata about each custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStores property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStores",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStores",
"fluentSetterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStores",
"getterDocumentation" : "Contains metadata about each custom key store.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasCustomKeyStores()} to see if a value was sent in this field.\n
\n@return Contains metadata about each custom key store.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStores",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStores",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "CustomKeyStoresListEntry",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link CustomKeyStoresListEntry.Builder} avoiding the need to create one manually via {@link CustomKeyStoresListEntry#builder()}.\n\nWhen the {@link Consumer} completes, {@link CustomKeyStoresListEntry.Builder#build()} is called immediately and its result is passed to {@link #member(CustomKeyStoresListEntry)}.\n@param member a consumer that will call methods on {@link CustomKeyStoresListEntry.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(CustomKeyStoresListEntry)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(CustomKeyStoresListEntry)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "CustomKeyStoresListEntry",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "member",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : null,
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "member",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : "",
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "CustomKeyStoresListEntry",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "CustomKeyStoresListEntry",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "CustomKeyStores",
"sensitive" : false,
"setterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.",
"setterMethodName" : "setCustomKeyStores",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customKeyStores",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customKeyStores",
"variableType" : "java.util.List",
"documentation" : "Contains metadata about each custom key store.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"NextMarker" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getNextMarker",
"beanStyleSetterMethodName" : "setNextMarker",
"c2jName" : "NextMarker",
"c2jShape" : "MarkerType",
"defaultConsumerFluentSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #nextMarker(String)}.\n@param nextMarker a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #nextMarker(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@return When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@deprecated Use {@link #nextMarker()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #nextMarker(String)}\n",
"documentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the NextMarker property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasNextMarker",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "nextMarker",
"fluentSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "nextMarker",
"getterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@return When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "NextMarker",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "NextMarker",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "NextMarker",
"sensitive" : false,
"setterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.",
"setterMethodName" : "setNextMarker",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "nextMarker",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "nextMarker",
"variableType" : "String",
"documentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Truncated" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTruncated",
"beanStyleSetterMethodName" : "setTruncated",
"c2jName" : "Truncated",
"c2jShape" : "BooleanType",
"defaultConsumerFluentSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #truncated(Boolean)}.\n@param truncated a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #truncated(Boolean)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@return A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@deprecated Use {@link #truncated()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #truncated(Boolean)}\n",
"documentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Truncated property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTruncated",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "truncated",
"fluentSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "truncated",
"getterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@return A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Truncated",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Truncated",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "Truncated",
"sensitive" : false,
"setterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.",
"setterMethodName" : "setTruncated",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "truncated",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "truncated",
"variableType" : "Boolean",
"documentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getCustomKeyStores",
"beanStyleSetterMethodName" : "setCustomKeyStores",
"c2jName" : "CustomKeyStores",
"c2jShape" : "CustomKeyStoresList",
"defaultConsumerFluentSetterDocumentation" : "Contains metadata about each custom key store.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #customKeyStores(List)}.\n@param customKeyStores a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStores(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Contains metadata about each custom key store.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasCustomKeyStores()} to see if a value was sent in this field.\n
\n@return Contains metadata about each custom key store.\n@deprecated Use {@link #customKeyStores()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStores(List)}\n",
"documentation" : "Contains metadata about each custom key store.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStores property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStores",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStores",
"fluentSetterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStores",
"getterDocumentation" : "Contains metadata about each custom key store.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasCustomKeyStores()} to see if a value was sent in this field.\n
\n@return Contains metadata about each custom key store.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStores",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStores",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "CustomKeyStoresListEntry",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link CustomKeyStoresListEntry.Builder} avoiding the need to create one manually via {@link CustomKeyStoresListEntry#builder()}.\n\nWhen the {@link Consumer} completes, {@link CustomKeyStoresListEntry.Builder#build()} is called immediately and its result is passed to {@link #member(CustomKeyStoresListEntry)}.\n@param member a consumer that will call methods on {@link CustomKeyStoresListEntry.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(CustomKeyStoresListEntry)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(CustomKeyStoresListEntry)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "CustomKeyStoresListEntry",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "member",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : null,
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "CustomKeyStoresListEntry",
"variableName" : "member",
"variableType" : "CustomKeyStoresListEntry",
"documentation" : "",
"simpleType" : "CustomKeyStoresListEntry",
"variableSetterType" : "CustomKeyStoresListEntry"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "CustomKeyStoresListEntry",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "CustomKeyStoresListEntry",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "CustomKeyStores",
"sensitive" : false,
"setterDocumentation" : "Contains metadata about each custom key store.
\n@param customKeyStores Contains metadata about each custom key store.",
"setterMethodName" : "setCustomKeyStores",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customKeyStores",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customKeyStores",
"variableType" : "java.util.List",
"documentation" : "Contains metadata about each custom key store.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getNextMarker",
"beanStyleSetterMethodName" : "setNextMarker",
"c2jName" : "NextMarker",
"c2jShape" : "MarkerType",
"defaultConsumerFluentSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #nextMarker(String)}.\n@param nextMarker a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #nextMarker(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@return When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@deprecated Use {@link #nextMarker()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #nextMarker(String)}\n",
"documentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the NextMarker property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasNextMarker",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "nextMarker",
"fluentSetterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "nextMarker",
"getterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@return When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "NextMarker",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "NextMarker",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "NextMarker",
"sensitive" : false,
"setterDocumentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
\n@param nextMarker When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.",
"setterMethodName" : "setNextMarker",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "nextMarker",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "nextMarker",
"variableType" : "String",
"documentation" : "When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getTruncated",
"beanStyleSetterMethodName" : "setTruncated",
"c2jName" : "Truncated",
"c2jShape" : "BooleanType",
"defaultConsumerFluentSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #truncated(Boolean)}.\n@param truncated a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #truncated(Boolean)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@return A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@deprecated Use {@link #truncated()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #truncated(Boolean)}\n",
"documentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Truncated property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTruncated",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "truncated",
"fluentSetterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "truncated",
"getterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@return A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Truncated",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Truncated",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "Truncated",
"sensitive" : false,
"setterDocumentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
\n@param truncated A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.",
"setterMethodName" : "setTruncated",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "truncated",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "truncated",
"variableType" : "Boolean",
"documentation" : "A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DescribeCustomKeyStoresResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DescribeCustomKeyStoresResponse",
"variableName" : "describeCustomKeyStoresResponse",
"variableType" : "DescribeCustomKeyStoresResponse",
"documentation" : null,
"simpleType" : "DescribeCustomKeyStoresResponse",
"variableSetterType" : "DescribeCustomKeyStoresResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeKeyRequest" : {
"c2jName" : "DescribeKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DescribeKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DescribeKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"GrantTokens" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "DescribeKeyRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DescribeKeyRequest",
"variableName" : "describeKeyRequest",
"variableType" : "DescribeKeyRequest",
"documentation" : null,
"simpleType" : "DescribeKeyRequest",
"variableSetterType" : "DescribeKeyRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeKeyResponse" : {
"c2jName" : "DescribeKeyResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyMetadata",
"beanStyleSetterMethodName" : "setKeyMetadata",
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"defaultConsumerFluentSetterDocumentation" : "Metadata associated with the key.
\nThis is a convenience that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to create one manually via {@link KeyMetadata#builder()}.\n\nWhen the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result is passed to {@link #keyMetadata(KeyMetadata)}.\n@param keyMetadata a consumer that will call methods on {@link KeyMetadata.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyMetadata(KeyMetadata)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Metadata associated with the key.
\n@return Metadata associated with the key.\n@deprecated Use {@link #keyMetadata()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyMetadata(KeyMetadata)}\n",
"documentation" : "Metadata associated with the key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyMetadata",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyMetadata",
"fluentSetterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyMetadata",
"getterDocumentation" : "Metadata associated with the key.
\n@return Metadata associated with the key.",
"getterModel" : {
"returnType" : "KeyMetadata",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "KeyMetadata",
"sensitive" : false,
"setterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.",
"setterMethodName" : "setKeyMetadata",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : null,
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the key.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyMetadata" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyMetadata",
"beanStyleSetterMethodName" : "setKeyMetadata",
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"defaultConsumerFluentSetterDocumentation" : "Metadata associated with the key.
\nThis is a convenience that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to create one manually via {@link KeyMetadata#builder()}.\n\nWhen the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result is passed to {@link #keyMetadata(KeyMetadata)}.\n@param keyMetadata a consumer that will call methods on {@link KeyMetadata.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyMetadata(KeyMetadata)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Metadata associated with the key.
\n@return Metadata associated with the key.\n@deprecated Use {@link #keyMetadata()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyMetadata(KeyMetadata)}\n",
"documentation" : "Metadata associated with the key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyMetadata",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyMetadata",
"fluentSetterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyMetadata",
"getterDocumentation" : "Metadata associated with the key.
\n@return Metadata associated with the key.",
"getterModel" : {
"returnType" : "KeyMetadata",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "KeyMetadata",
"sensitive" : false,
"setterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.",
"setterMethodName" : "setKeyMetadata",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : null,
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the key.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyMetadata",
"beanStyleSetterMethodName" : "setKeyMetadata",
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"defaultConsumerFluentSetterDocumentation" : "Metadata associated with the key.
\nThis is a convenience that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to create one manually via {@link KeyMetadata#builder()}.\n\nWhen the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result is passed to {@link #keyMetadata(KeyMetadata)}.\n@param keyMetadata a consumer that will call methods on {@link KeyMetadata.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyMetadata(KeyMetadata)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Metadata associated with the key.
\n@return Metadata associated with the key.\n@deprecated Use {@link #keyMetadata()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyMetadata(KeyMetadata)}\n",
"documentation" : "Metadata associated with the key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyMetadata",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyMetadata",
"fluentSetterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyMetadata",
"getterDocumentation" : "Metadata associated with the key.
\n@return Metadata associated with the key.",
"getterModel" : {
"returnType" : "KeyMetadata",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "KeyMetadata",
"sensitive" : false,
"setterDocumentation" : "Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.",
"setterMethodName" : "setKeyMetadata",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : null,
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the key.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DescribeKeyResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DescribeKeyResponse",
"variableName" : "describeKeyResponse",
"variableType" : "DescribeKeyResponse",
"documentation" : null,
"simpleType" : "DescribeKeyResponse",
"variableSetterType" : "DescribeKeyResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisableKeyRequest" : {
"c2jName" : "DisableKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DisableKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DisableKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "DisableKeyRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisableKeyRequest",
"variableName" : "disableKeyRequest",
"variableType" : "DisableKeyRequest",
"documentation" : null,
"simpleType" : "DisableKeyRequest",
"variableSetterType" : "DisableKeyRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisableKeyResponse" : {
"c2jName" : "DisableKeyResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DisableKeyResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DisableKeyResponse",
"variableName" : "disableKeyResponse",
"variableType" : "DisableKeyResponse",
"documentation" : null,
"simpleType" : "DisableKeyResponse",
"variableSetterType" : "DisableKeyResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisableKeyRotationRequest" : {
"c2jName" : "DisableKeyRotationRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DisableKeyRotation",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DisableKeyRotation",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "DisableKeyRotationRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisableKeyRotationRequest",
"variableName" : "disableKeyRotationRequest",
"variableType" : "DisableKeyRotationRequest",
"documentation" : null,
"simpleType" : "DisableKeyRotationRequest",
"variableSetterType" : "DisableKeyRotationRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisableKeyRotationResponse" : {
"c2jName" : "DisableKeyRotationResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DisableKeyRotationResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DisableKeyRotationResponse",
"variableName" : "disableKeyRotationResponse",
"variableType" : "DisableKeyRotationResponse",
"documentation" : null,
"simpleType" : "DisableKeyRotationResponse",
"variableSetterType" : "DisableKeyRotationResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisabledException" : {
"c2jName" : "DisabledException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The request was rejected because the specified CMK is not enabled.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "DisabledException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DisabledException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisabledException",
"variableName" : "disabledException",
"variableType" : "DisabledException",
"documentation" : null,
"simpleType" : "DisabledException",
"variableSetterType" : "DisabledException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisconnectCustomKeyStoreRequest" : {
"c2jName" : "DisconnectCustomKeyStoreRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DisconnectCustomKeyStore",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DisconnectCustomKeyStore",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomKeyStoreId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getCustomKeyStoreId",
"beanStyleSetterMethodName" : "setCustomKeyStoreId",
"c2jName" : "CustomKeyStoreId",
"c2jShape" : "CustomKeyStoreIdType",
"defaultConsumerFluentSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customKeyStoreId(String)}.\n@param customKeyStoreId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customKeyStoreId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@deprecated Use {@link #customKeyStoreId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #customKeyStoreId(String)}\n",
"documentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the CustomKeyStoreId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasCustomKeyStoreId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customKeyStoreId",
"fluentSetterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customKeyStoreId",
"getterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@return Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "CustomKeyStoreId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomKeyStoreId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomKeyStoreId",
"sensitive" : false,
"setterDocumentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
\n@param customKeyStoreId Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.",
"setterMethodName" : "setCustomKeyStoreId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customKeyStoreId",
"variableType" : "String",
"documentation" : "Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "CustomKeyStoreId" ],
"shapeName" : "DisconnectCustomKeyStoreRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisconnectCustomKeyStoreRequest",
"variableName" : "disconnectCustomKeyStoreRequest",
"variableType" : "DisconnectCustomKeyStoreRequest",
"documentation" : null,
"simpleType" : "DisconnectCustomKeyStoreRequest",
"variableSetterType" : "DisconnectCustomKeyStoreRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DisconnectCustomKeyStoreResponse" : {
"c2jName" : "DisconnectCustomKeyStoreResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DisconnectCustomKeyStoreResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DisconnectCustomKeyStoreResponse",
"variableName" : "disconnectCustomKeyStoreResponse",
"variableType" : "DisconnectCustomKeyStoreResponse",
"documentation" : null,
"simpleType" : "DisconnectCustomKeyStoreResponse",
"variableSetterType" : "DisconnectCustomKeyStoreResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"EnableKeyRequest" : {
"c2jName" : "EnableKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "EnableKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.EnableKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "EnableKeyRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "EnableKeyRequest",
"variableName" : "enableKeyRequest",
"variableType" : "EnableKeyRequest",
"documentation" : null,
"simpleType" : "EnableKeyRequest",
"variableSetterType" : "EnableKeyRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"EnableKeyResponse" : {
"c2jName" : "EnableKeyResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "EnableKeyResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "EnableKeyResponse",
"variableName" : "enableKeyResponse",
"variableType" : "EnableKeyResponse",
"documentation" : null,
"simpleType" : "EnableKeyResponse",
"variableSetterType" : "EnableKeyResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"EnableKeyRotationRequest" : {
"c2jName" : "EnableKeyRotationRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "EnableKeyRotation",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.EnableKeyRotation",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@return Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
\n@param keyId Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "KeyId" ],
"shapeName" : "EnableKeyRotationRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "EnableKeyRotationRequest",
"variableName" : "enableKeyRotationRequest",
"variableType" : "EnableKeyRotationRequest",
"documentation" : null,
"simpleType" : "EnableKeyRotationRequest",
"variableSetterType" : "EnableKeyRotationRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"EnableKeyRotationResponse" : {
"c2jName" : "EnableKeyRotationResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "EnableKeyRotationResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "EnableKeyRotationResponse",
"variableName" : "enableKeyRotationResponse",
"variableType" : "EnableKeyRotationResponse",
"documentation" : null,
"simpleType" : "EnableKeyRotationResponse",
"variableSetterType" : "EnableKeyRotationResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"EncryptRequest" : {
"c2jName" : "EncryptRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "Encrypt",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.Encrypt",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPlaintext",
"beanStyleSetterMethodName" : "setPlaintext",
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"defaultConsumerFluentSetterDocumentation" : "Data to be encrypted.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #plaintext(SdkBytes)}.\n@param plaintext a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #plaintext(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Data to be encrypted.
\n@return Data to be encrypted.\n@deprecated Use {@link #plaintext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #plaintext(SdkBytes)}\n",
"documentation" : "Data to be encrypted.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Plaintext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPlaintext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "plaintext",
"fluentSetterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "plaintext",
"getterDocumentation" : "Data to be encrypted.
\n@return Data to be encrypted.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Plaintext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Plaintext",
"sensitive" : true,
"setterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.",
"setterMethodName" : "setPlaintext",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Data to be encrypted.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getEncryptionContext",
"beanStyleSetterMethodName" : "setEncryptionContext",
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #encryptionContext(Map)}.\n@param encryptionContext a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionContext(Map)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #encryptionContext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #encryptionContext(Map)}\n",
"documentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionContext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "encryptionContext",
"fluentSetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "encryptionContext",
"getterDocumentation" : "
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "EncryptionContextKey",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.\n@deprecated Use {@link #key()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #key(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.\n@deprecated Use {@link #value()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #value(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Value property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasValue",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "EncryptionContext",
"sensitive" : false,
"setterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setEncryptionContext",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n@param encryptionAlgorithm Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n@param encryptionAlgorithm Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n@param encryptionAlgorithm Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"EncryptionAlgorithm" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEncryptionAlgorithm",
"beanStyleSetterMethodName" : "setEncryptionAlgorithm",
"c2jName" : "EncryptionAlgorithm",
"c2jShape" : "EncryptionAlgorithmSpec",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #encryptionAlgorithmAsString(String)}.\n@param encryptionAlgorithm a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionAlgorithm(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithmAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n@param encryptionAlgorithm Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec\n@deprecated Use {@link #encryptionAlgorithm(String)}\n",
"documentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
",
"endpointDiscoveryId" : false,
"enumType" : "EncryptionAlgorithmSpec",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionAlgorithm property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionAlgorithm",
"fluentEnumGetterMethodName" : "encryptionAlgorithm",
"fluentEnumSetterMethodName" : "encryptionAlgorithm",
"fluentGetterMethodName" : "encryptionAlgorithmAsString",
"fluentSetterDocumentation" : "Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n@param encryptionAlgorithm Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec\n@return Returns a reference to this object so that method calls can be chained together.\n@see EncryptionAlgorithmSpec",
"fluentSetterMethodName" : "encryptionAlgorithm",
"getterDocumentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #encryptionAlgorithm} will return {@link EncryptionAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #encryptionAlgorithmAsString}.\n
\n@return Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionAlgorithm",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionAlgorithm",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EncryptionAlgorithm",
"sensitive" : false,
"setterDocumentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
\n@param encryptionAlgorithm Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify. This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.\n@see EncryptionAlgorithmSpec",
"setterMethodName" : "setEncryptionAlgorithm",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "encryptionAlgorithm",
"variableType" : "String",
"documentation" : "
Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.
This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"EncryptionContext" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getEncryptionContext",
"beanStyleSetterMethodName" : "setEncryptionContext",
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #encryptionContext(Map)}.\n@param encryptionContext a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionContext(Map)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #encryptionContext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #encryptionContext(Map)}\n",
"documentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionContext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "encryptionContext",
"fluentSetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "encryptionContext",
"getterDocumentation" : "
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "EncryptionContextKey",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.\n@deprecated Use {@link #key()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #key(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.\n@deprecated Use {@link #value()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #value(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Value property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasValue",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "EncryptionContext",
"sensitive" : false,
"setterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setEncryptionContext",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"GrantTokens" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List)}.\n@param grantTokens a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #grantTokens(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #grantTokens()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #grantTokens(List)}\n",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the GrantTokens property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasGrantTokens",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "grantTokens",
"fluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "grantTokens",
"getterDocumentation" : "
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasGrantTokens()} to see if a value was sent in this field.\n
\n@return A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "GrantTokens",
"sensitive" : false,
"setterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\n@param grantTokens A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setGrantTokens",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"KeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Plaintext" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPlaintext",
"beanStyleSetterMethodName" : "setPlaintext",
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"defaultConsumerFluentSetterDocumentation" : "Data to be encrypted.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #plaintext(SdkBytes)}.\n@param plaintext a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #plaintext(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Data to be encrypted.
\n@return Data to be encrypted.\n@deprecated Use {@link #plaintext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #plaintext(SdkBytes)}\n",
"documentation" : "Data to be encrypted.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Plaintext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPlaintext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "plaintext",
"fluentSetterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "plaintext",
"getterDocumentation" : "Data to be encrypted.
\n@return Data to be encrypted.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Plaintext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Plaintext",
"sensitive" : true,
"setterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.",
"setterMethodName" : "setPlaintext",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Data to be encrypted.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKeyId",
"beanStyleSetterMethodName" : "setKeyId",
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #keyId(String)}.\n@param keyId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #keyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@deprecated Use {@link #keyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #keyId(String)}\n",
"documentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the KeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "keyId",
"fluentSetterDocumentation" : "A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "keyId",
"getterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@return A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "KeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "KeyId",
"sensitive" : false,
"setterDocumentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
\n@param keyId A unique identifier for the customer master key (CMK). To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.",
"setterMethodName" : "setKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.
For example:
-
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name: alias/ExampleAlias
-
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPlaintext",
"beanStyleSetterMethodName" : "setPlaintext",
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"defaultConsumerFluentSetterDocumentation" : "Data to be encrypted.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #plaintext(SdkBytes)}.\n@param plaintext a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #plaintext(SdkBytes)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Data to be encrypted.
\n@return Data to be encrypted.\n@deprecated Use {@link #plaintext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #plaintext(SdkBytes)}\n",
"documentation" : "Data to be encrypted.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Plaintext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPlaintext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "plaintext",
"fluentSetterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "plaintext",
"getterDocumentation" : "Data to be encrypted.
\n@return Data to be encrypted.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Plaintext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Plaintext",
"sensitive" : true,
"setterDocumentation" : "Data to be encrypted.
\n@param plaintext Data to be encrypted.",
"setterMethodName" : "setPlaintext",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "plaintext",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "Data to be encrypted.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getEncryptionContext",
"beanStyleSetterMethodName" : "setEncryptionContext",
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #encryptionContext(Map)}.\n@param encryptionContext a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #encryptionContext(Map)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@deprecated Use {@link #encryptionContext()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #encryptionContext(Map)}\n",
"documentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EncryptionContext property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEncryptionContext",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "encryptionContext",
"fluentSetterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "encryptionContext",
"getterDocumentation" : "
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasEncryptionContext()} to see if a value was sent in this field.\n
\n@return Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "EncryptionContextKey",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.\n@deprecated Use {@link #key()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #key(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Key property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.\n@deprecated Use {@link #value()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #value(String)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Value property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasValue",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "EncryptionContext",
"sensitive" : false,
"setterDocumentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param encryptionContext Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.",
"setterMethodName" : "setEncryptionContext",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getGrantTokens",
"beanStyleSetterMethodName" : "setGrantTokens",
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"defaultConsumerFluentSetterDocumentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #grantTokens(List