
models.kms-2014-11-01-intermediate.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
{
"customizationConfig" : {
"additionalShapeConstructors" : null,
"authPolicyActions" : {
"actionPrefix" : null,
"fileNamePrefix" : null,
"skip" : true
},
"calculateCRC32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customClientConfigFactory" : null,
"customCodeTemplates" : null,
"customErrorCodeFieldName" : null,
"customExceptionUnmarshallerImpl" : null,
"customFileHeader" : null,
"customResponseMetadataClassName" : null,
"customServiceMetadata" : null,
"customServiceNameForRequest" : null,
"customSignerProvider" : null,
"operationModifiers" : null,
"operationsWithResponseStreamContentLengthValidation" : null,
"renameShapes" : null,
"requestMetrics" : null,
"requiredParamValidationEnabled" : false,
"sdkModeledExceptionBaseClassName" : null,
"sendEmptyAutoConstructedListAsEmptyList" : null,
"sendExplicitlyEmptyListsForQuery" : false,
"serviceClientHoldInputStream" : false,
"shapeModifiers" : null,
"shapeSubstitutions" : null,
"simpleMethods" : {
"CreateKey" : {
"methodForms" : [ [ ] ]
},
"GenerateRandom" : {
"methodForms" : [ [ ] ]
},
"ListAliases" : {
"methodForms" : [ [ ] ]
},
"ListKeys" : {
"methodForms" : [ [ ] ]
},
"RetireGrant" : {
"methodForms" : [ [ ] ]
}
},
"skipInterfaceAdditions" : false,
"skipSmokeTests" : false,
"useAutoConstructList" : true,
"useAutoConstructMap" : true
},
"metadata" : {
"apiVersion" : "2014-11-01",
"asyncClient" : "AWSKMSAsyncClient",
"asyncClientBuilderClassName" : "AWSKMSAsyncClientBuilder",
"asyncInterface" : "AWSKMSAsync",
"cborProtocol" : false,
"checksumFormat" : null,
"contentType" : null,
"cucumberModuleInjectorClassName" : "AWSKMSModuleInjector",
"defaultEndpoint" : "https://kms.us-east-1.amazonaws.com/",
"defaultEndpointWithoutHttpProtocol" : "kms.us-east-1.amazonaws.com/",
"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, iOS, 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, or you can 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 APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
",
"endpointPrefix" : "kms",
"hasApiWithStreamInput" : false,
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"packageName" : "com.amazonaws.services.kms",
"packagePath" : "com/amazonaws/services/kms",
"protocol" : "json",
"protocolDefaultExceptionUmarshallerImpl" : null,
"serviceAbbreviation" : "KMS",
"serviceFullName" : "AWS Key Management Service",
"serviceName" : "KMS",
"signingName" : "kms",
"smokeTestsPackageName" : "com.amazonaws.services.kms.smoketests",
"syncClient" : "AWSKMSClient",
"syncClientBuilderClassName" : "AWSKMSClientBuilder",
"syncInterface" : "AWSKMS",
"unmarshallerClassSuffix" : "JsonUnmarshaller",
"unmarshallerContextClassName" : "JsonUnmarshallerContext",
"xmlProtocol" : false
},
"operations" : {
"CancelKeyDeletion" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CancelKeyDeletionResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled
state. To enable a CMK, use EnableKey.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CancelKeyDeletionRequest",
"variableName" : "cancelKeyDeletionRequest",
"variableType" : "CancelKeyDeletionRequest",
"documentation" : "",
"simpleType" : "CancelKeyDeletionRequest",
"variableSetterType" : "CancelKeyDeletionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "cancelKeyDeletion",
"operationName" : "CancelKeyDeletion",
"returnType" : {
"returnType" : "CancelKeyDeletionResult",
"documentation" : null
},
"syncReturnType" : "CancelKeyDeletionResult"
},
"CreateAlias" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateAliasResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "AlreadyExistsException",
"documentation" : "The request was rejected because it attempted to create a resource that already exists.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidAliasNameException",
"documentation" : "The request was rejected because the specified alias name is not valid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateAliasRequest",
"variableName" : "createAliasRequest",
"variableType" : "CreateAliasRequest",
"documentation" : "",
"simpleType" : "CreateAliasRequest",
"variableSetterType" : "CreateAliasRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createAlias",
"operationName" : "CreateAlias",
"returnType" : {
"returnType" : "CreateAliasResult",
"documentation" : null
},
"syncReturnType" : "CreateAliasResult"
},
"CreateGrant" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateGrantResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateGrantRequest",
"variableName" : "createGrantRequest",
"variableType" : "CreateGrantRequest",
"documentation" : "",
"simpleType" : "CreateGrantRequest",
"variableSetterType" : "CreateGrantRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createGrant",
"operationName" : "CreateGrant",
"returnType" : {
"returnType" : "CreateGrantResult",
"documentation" : null
},
"syncReturnType" : "CreateGrantResult"
},
"CreateKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
-
The GenerateDataKey operation
-
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
",
"exceptions" : [ {
"exceptionName" : "MalformedPolicyDocumentException",
"documentation" : "The request was rejected because the specified policy is not syntactically or semantically correct.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateKeyRequest",
"variableName" : "createKeyRequest",
"variableType" : "CreateKeyRequest",
"documentation" : "",
"simpleType" : "CreateKeyRequest",
"variableSetterType" : "CreateKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createKey",
"operationName" : "CreateKey",
"returnType" : {
"returnType" : "CreateKeyResult",
"documentation" : null
},
"syncReturnType" : "CreateKeyResult"
},
"Decrypt" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DecryptResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt
access in an IAM user policy. Instead grant Decrypt
access only in key policies. If you must grant Decrypt
access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "InvalidCiphertextException",
"documentation" : "The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
"
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the key was not available. The request can be retried.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DecryptRequest",
"variableName" : "decryptRequest",
"variableType" : "DecryptRequest",
"documentation" : "",
"simpleType" : "DecryptRequest",
"variableSetterType" : "DecryptRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "decrypt",
"operationName" : "Decrypt",
"returnType" : {
"returnType" : "DecryptResult",
"documentation" : null
},
"syncReturnType" : "DecryptResult"
},
"DeleteAlias" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteAliasResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteAliasRequest",
"variableName" : "deleteAliasRequest",
"variableType" : "DeleteAliasRequest",
"documentation" : "",
"simpleType" : "DeleteAliasRequest",
"variableSetterType" : "DeleteAliasRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteAlias",
"operationName" : "DeleteAlias",
"returnType" : {
"returnType" : "DeleteAliasResult",
"documentation" : null
},
"syncReturnType" : "DeleteAliasResult"
},
"DeleteImportedKeyMaterial" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteImportedKeyMaterialResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes key material that you previously imported and 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.
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.
",
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteImportedKeyMaterialRequest",
"variableName" : "deleteImportedKeyMaterialRequest",
"variableType" : "DeleteImportedKeyMaterialRequest",
"documentation" : "",
"simpleType" : "DeleteImportedKeyMaterialRequest",
"variableSetterType" : "DeleteImportedKeyMaterialRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteImportedKeyMaterial",
"operationName" : "DeleteImportedKeyMaterial",
"returnType" : {
"returnType" : "DeleteImportedKeyMaterialResult",
"documentation" : null
},
"syncReturnType" : "DeleteImportedKeyMaterialResult"
},
"DescribeKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Provides detailed information about the specified customer master key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeKeyRequest",
"variableName" : "describeKeyRequest",
"variableType" : "DescribeKeyRequest",
"documentation" : "",
"simpleType" : "DescribeKeyRequest",
"variableSetterType" : "DescribeKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeKey",
"operationName" : "DescribeKey",
"returnType" : {
"returnType" : "DescribeKeyResult",
"documentation" : null
},
"syncReturnType" : "DescribeKeyResult"
},
"DisableKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DisableKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. 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.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DisableKeyRequest",
"variableName" : "disableKeyRequest",
"variableType" : "DisableKeyRequest",
"documentation" : "",
"simpleType" : "DisableKeyRequest",
"variableSetterType" : "DisableKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "disableKey",
"operationName" : "DisableKey",
"returnType" : {
"returnType" : "DisableKeyResult",
"documentation" : null
},
"syncReturnType" : "DisableKeyResult"
},
"DisableKeyRotation" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DisableKeyRotationResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Disables rotation of the specified key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DisableKeyRotationRequest",
"variableName" : "disableKeyRotationRequest",
"variableType" : "DisableKeyRotationRequest",
"documentation" : "",
"simpleType" : "DisableKeyRotationRequest",
"variableSetterType" : "DisableKeyRotationRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "disableKeyRotation",
"operationName" : "DisableKeyRotation",
"returnType" : {
"returnType" : "DisableKeyRotationResult",
"documentation" : null
},
"syncReturnType" : "DisableKeyRotationResult"
},
"EnableKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EnableKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Marks a key as enabled, thereby permitting its use.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "EnableKeyRequest",
"variableName" : "enableKeyRequest",
"variableType" : "EnableKeyRequest",
"documentation" : "",
"simpleType" : "EnableKeyRequest",
"variableSetterType" : "EnableKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "enableKey",
"operationName" : "EnableKey",
"returnType" : {
"returnType" : "EnableKeyResult",
"documentation" : null
},
"syncReturnType" : "EnableKeyResult"
},
"EnableKeyRotation" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EnableKeyRotationResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Enables rotation of the specified customer master key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "EnableKeyRotationRequest",
"variableName" : "enableKeyRotationRequest",
"variableType" : "EnableKeyRotationRequest",
"documentation" : "",
"simpleType" : "EnableKeyRotationRequest",
"variableSetterType" : "EnableKeyRotationRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "enableKeyRotation",
"operationName" : "EnableKeyRotation",
"returnType" : {
"returnType" : "EnableKeyRotationResult",
"documentation" : null
},
"syncReturnType" : "EnableKeyRotationResult"
},
"Encrypt" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "EncryptResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Encrypts plaintext into ciphertext by using a customer master key. The Encrypt
function has two primary use cases:
-
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
-
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt
.
If you want to encrypt data locally in your application, you can use the GenerateDataKey
function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the key was not available. The request can be retried.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
"
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "EncryptRequest",
"variableName" : "encryptRequest",
"variableType" : "EncryptRequest",
"documentation" : "",
"simpleType" : "EncryptRequest",
"variableSetterType" : "EncryptRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "encrypt",
"operationName" : "Encrypt",
"returnType" : {
"returnType" : "EncryptResult",
"documentation" : null
},
"syncReturnType" : "EncryptResult"
},
"GenerateDataKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GenerateDataKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the Plaintext
field of the response object and an encrypted copy of the key in the CiphertextBlob
field. The key is encrypted by using the master key specified by the KeyId
field. To decrypt the encrypted key, pass it to the Decrypt
API.
We recommend that you use the following pattern to locally encrypt data: call the GenerateDataKey
API, use the key returned in the Plaintext
response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the CiphertextBlob
field) alongside of the locally encrypted data.
You should not call the Encrypt
function to re-encrypt your data keys within a region. GenerateDataKey
always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.
If you decide to use the optional EncryptionContext
parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the Decrypt
API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context.
To decrypt data, pass the encrypted data key to the Decrypt
API. Decrypt
uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the key was not available. The request can be retried.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
"
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateDataKeyRequest",
"variableName" : "generateDataKeyRequest",
"variableType" : "GenerateDataKeyRequest",
"documentation" : "",
"simpleType" : "GenerateDataKeyRequest",
"variableSetterType" : "GenerateDataKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "generateDataKey",
"operationName" : "GenerateDataKey",
"returnType" : {
"returnType" : "GenerateDataKeyResult",
"documentation" : null
},
"syncReturnType" : "GenerateDataKeyResult"
},
"GenerateDataKeyWithoutPlaintext" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GenerateDataKeyWithoutPlaintextResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the key was not available. The request can be retried.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
"
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateDataKeyWithoutPlaintextRequest",
"variableName" : "generateDataKeyWithoutPlaintextRequest",
"variableType" : "GenerateDataKeyWithoutPlaintextRequest",
"documentation" : "",
"simpleType" : "GenerateDataKeyWithoutPlaintextRequest",
"variableSetterType" : "GenerateDataKeyWithoutPlaintextRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "generateDataKeyWithoutPlaintext",
"operationName" : "GenerateDataKeyWithoutPlaintext",
"returnType" : {
"returnType" : "GenerateDataKeyWithoutPlaintextResult",
"documentation" : null
},
"syncReturnType" : "GenerateDataKeyWithoutPlaintextResult"
},
"GenerateRandom" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GenerateRandomResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates an unpredictable byte string.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateRandomRequest",
"variableName" : "generateRandomRequest",
"variableType" : "GenerateRandomRequest",
"documentation" : "",
"simpleType" : "GenerateRandomRequest",
"variableSetterType" : "GenerateRandomRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "generateRandom",
"operationName" : "GenerateRandom",
"returnType" : {
"returnType" : "GenerateRandomResult",
"documentation" : null
},
"syncReturnType" : "GenerateRandomResult"
},
"GetKeyPolicy" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetKeyPolicyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Retrieves a policy attached to the specified key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetKeyPolicyRequest",
"variableName" : "getKeyPolicyRequest",
"variableType" : "GetKeyPolicyRequest",
"documentation" : "",
"simpleType" : "GetKeyPolicyRequest",
"variableSetterType" : "GetKeyPolicyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getKeyPolicy",
"operationName" : "GetKeyPolicy",
"returnType" : {
"returnType" : "GetKeyPolicyResult",
"documentation" : null
},
"syncReturnType" : "GetKeyPolicyResult"
},
"GetKeyRotationStatus" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetKeyRotationStatusResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetKeyRotationStatusRequest",
"variableName" : "getKeyRotationStatusRequest",
"variableType" : "GetKeyRotationStatusRequest",
"documentation" : "",
"simpleType" : "GetKeyRotationStatusRequest",
"variableSetterType" : "GetKeyRotationStatusRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getKeyRotationStatus",
"operationName" : "GetKeyRotationStatus",
"returnType" : {
"returnType" : "GetKeyRotationStatusResult",
"documentation" : null
},
"syncReturnType" : "GetKeyRotationStatusResult"
},
"GetParametersForImport" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetParametersForImportResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the items you need in order to import key material into AWS KMS 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.
You must specify the key ID of the customer master key (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.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport
request.
",
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetParametersForImportRequest",
"variableName" : "getParametersForImportRequest",
"variableType" : "GetParametersForImportRequest",
"documentation" : "",
"simpleType" : "GetParametersForImportRequest",
"variableSetterType" : "GetParametersForImportRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getParametersForImport",
"operationName" : "GetParametersForImport",
"returnType" : {
"returnType" : "GetParametersForImportResult",
"documentation" : null
},
"syncReturnType" : "GetParametersForImportResult"
},
"ImportKeyMaterial" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ImportKeyMaterialResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Imports key material into an AWS KMS customer master key (CMK) 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.
You must specify the key ID of the CMK to import the key material into. This CMK's Origin
must be EXTERNAL
. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes to Enabled
, and you can use the CMK.
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.
",
"exceptions" : [ {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
}, {
"exceptionName" : "InvalidCiphertextException",
"documentation" : "The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
"
}, {
"exceptionName" : "IncorrectKeyMaterialException",
"documentation" : "The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).
"
}, {
"exceptionName" : "ExpiredImportTokenException",
"documentation" : "The request was rejected because the provided import token is expired. Use GetParametersForImport to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
"
}, {
"exceptionName" : "InvalidImportTokenException",
"documentation" : "The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportKeyMaterialRequest",
"variableName" : "importKeyMaterialRequest",
"variableType" : "ImportKeyMaterialRequest",
"documentation" : "",
"simpleType" : "ImportKeyMaterialRequest",
"variableSetterType" : "ImportKeyMaterialRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "importKeyMaterial",
"operationName" : "ImportKeyMaterial",
"returnType" : {
"returnType" : "ImportKeyMaterialResult",
"documentation" : null
},
"syncReturnType" : "ImportKeyMaterialResult"
},
"ListAliases" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListAliasesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists all of the key aliases in the account.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListAliasesRequest",
"variableName" : "listAliasesRequest",
"variableType" : "ListAliasesRequest",
"documentation" : "",
"simpleType" : "ListAliasesRequest",
"variableSetterType" : "ListAliasesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listAliases",
"operationName" : "ListAliases",
"returnType" : {
"returnType" : "ListAliasesResult",
"documentation" : null
},
"syncReturnType" : "ListAliasesResult"
},
"ListGrants" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListGrantsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "List the grants for a specified key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListGrantsRequest",
"variableName" : "listGrantsRequest",
"variableType" : "ListGrantsRequest",
"documentation" : "",
"simpleType" : "ListGrantsRequest",
"variableSetterType" : "ListGrantsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listGrants",
"operationName" : "ListGrants",
"returnType" : {
"returnType" : "ListGrantsResult",
"documentation" : null
},
"syncReturnType" : "ListGrantsResult"
},
"ListKeyPolicies" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListKeyPoliciesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Retrieves a list of policies attached to a key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListKeyPoliciesRequest",
"variableName" : "listKeyPoliciesRequest",
"variableType" : "ListKeyPoliciesRequest",
"documentation" : "",
"simpleType" : "ListKeyPoliciesRequest",
"variableSetterType" : "ListKeyPoliciesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listKeyPolicies",
"operationName" : "ListKeyPolicies",
"returnType" : {
"returnType" : "ListKeyPoliciesResult",
"documentation" : null
},
"syncReturnType" : "ListKeyPoliciesResult"
},
"ListKeys" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListKeysResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the customer master keys.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListKeysRequest",
"variableName" : "listKeysRequest",
"variableType" : "ListKeysRequest",
"documentation" : "",
"simpleType" : "ListKeysRequest",
"variableSetterType" : "ListKeysRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listKeys",
"operationName" : "ListKeys",
"returnType" : {
"returnType" : "ListKeysResult",
"documentation" : null
},
"syncReturnType" : "ListKeysResult"
},
"ListRetirableGrants" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListRetirableGrantsResult",
"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.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidMarkerException",
"documentation" : "The request was rejected because the marker that specifies where pagination should next begin is not valid.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListRetirableGrantsRequest",
"variableName" : "listRetirableGrantsRequest",
"variableType" : "ListRetirableGrantsRequest",
"documentation" : "",
"simpleType" : "ListRetirableGrantsRequest",
"variableSetterType" : "ListRetirableGrantsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listRetirableGrants",
"operationName" : "ListRetirableGrants",
"returnType" : {
"returnType" : "ListRetirableGrantsResult",
"documentation" : null
},
"syncReturnType" : "ListRetirableGrantsResult"
},
"PutKeyPolicy" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "PutKeyPolicyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "MalformedPolicyDocumentException",
"documentation" : "The request was rejected because the specified policy is not syntactically or semantically correct.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "UnsupportedOperationException",
"documentation" : "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutKeyPolicyRequest",
"variableName" : "putKeyPolicyRequest",
"variableType" : "PutKeyPolicyRequest",
"documentation" : "",
"simpleType" : "PutKeyPolicyRequest",
"variableSetterType" : "PutKeyPolicyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "putKeyPolicy",
"operationName" : "PutKeyPolicy",
"returnType" : {
"returnType" : "PutKeyPolicyResult",
"documentation" : null
},
"syncReturnType" : "PutKeyPolicyResult"
},
"ReEncrypt" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ReEncryptResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt
is authorized twice - once as ReEncryptFrom
on the source key and once as ReEncryptTo
on the destination key. We therefore recommend that you include the \"action\":\"kms:ReEncrypt*\"
statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DisabledException",
"documentation" : "The request was rejected because the specified key was marked as disabled.
"
}, {
"exceptionName" : "InvalidCiphertextException",
"documentation" : "The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
"
}, {
"exceptionName" : "KeyUnavailableException",
"documentation" : "The request was rejected because the key was not available. The request can be retried.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidKeyUsageException",
"documentation" : "The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
"
}, {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ReEncryptRequest",
"variableName" : "reEncryptRequest",
"variableType" : "ReEncryptRequest",
"documentation" : "",
"simpleType" : "ReEncryptRequest",
"variableSetterType" : "ReEncryptRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "reEncrypt",
"operationName" : "ReEncrypt",
"returnType" : {
"returnType" : "ReEncryptResult",
"documentation" : null
},
"syncReturnType" : "ReEncryptResult"
},
"RetireGrant" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "RetireGrantResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
-
The RetiringPrincipal
, if present
-
The GranteePrincipal
, if RetireGrant
is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant
function.
",
"exceptions" : [ {
"exceptionName" : "InvalidGrantTokenException",
"documentation" : "The request was rejected because a grant token provided as part of the request is invalid.
"
}, {
"exceptionName" : "InvalidGrantIdException",
"documentation" : "The request was rejected because the specified GrantId
is not valid.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RetireGrantRequest",
"variableName" : "retireGrantRequest",
"variableType" : "RetireGrantRequest",
"documentation" : "",
"simpleType" : "RetireGrantRequest",
"variableSetterType" : "RetireGrantRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "retireGrant",
"operationName" : "RetireGrant",
"returnType" : {
"returnType" : "RetireGrantResult",
"documentation" : null
},
"syncReturnType" : "RetireGrantResult"
},
"RevokeGrant" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "RevokeGrantResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "InvalidGrantIdException",
"documentation" : "The request was rejected because the specified GrantId
is not valid.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RevokeGrantRequest",
"variableName" : "revokeGrantRequest",
"variableType" : "RevokeGrantRequest",
"documentation" : "",
"simpleType" : "RevokeGrantRequest",
"variableSetterType" : "RevokeGrantRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "revokeGrant",
"operationName" : "RevokeGrant",
"returnType" : {
"returnType" : "RevokeGrantResult",
"documentation" : null
},
"syncReturnType" : "RevokeGrantResult"
},
"ScheduleKeyDeletion" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ScheduleKeyDeletionResult",
"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 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 point 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 rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ScheduleKeyDeletionRequest",
"variableName" : "scheduleKeyDeletionRequest",
"variableType" : "ScheduleKeyDeletionRequest",
"documentation" : "",
"simpleType" : "ScheduleKeyDeletionRequest",
"variableSetterType" : "ScheduleKeyDeletionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "scheduleKeyDeletion",
"operationName" : "ScheduleKeyDeletion",
"returnType" : {
"returnType" : "ScheduleKeyDeletionResult",
"documentation" : null
},
"syncReturnType" : "ScheduleKeyDeletionResult"
},
"UpdateAlias" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateAliasResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
",
"exceptions" : [ {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateAliasRequest",
"variableName" : "updateAliasRequest",
"variableType" : "UpdateAliasRequest",
"documentation" : "",
"simpleType" : "UpdateAliasRequest",
"variableSetterType" : "UpdateAliasRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateAlias",
"operationName" : "UpdateAlias",
"returnType" : {
"returnType" : "UpdateAliasResult",
"documentation" : null
},
"syncReturnType" : "UpdateAliasResult"
},
"UpdateKeyDescription" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateKeyDescriptionResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the description of a key.
",
"exceptions" : [ {
"exceptionName" : "NotFoundException",
"documentation" : "The request was rejected because the specified entity or resource could not be found.
"
}, {
"exceptionName" : "InvalidArnException",
"documentation" : "The request was rejected because a specified ARN was not valid.
"
}, {
"exceptionName" : "DependencyTimeoutException",
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
"
}, {
"exceptionName" : "KMSInternalException",
"documentation" : "The request was rejected because an internal exception occurred. The request can be retried.
"
}, {
"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 customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateKeyDescriptionRequest",
"variableName" : "updateKeyDescriptionRequest",
"variableType" : "UpdateKeyDescriptionRequest",
"documentation" : "",
"simpleType" : "UpdateKeyDescriptionRequest",
"variableSetterType" : "UpdateKeyDescriptionRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateKeyDescription",
"operationName" : "UpdateKeyDescription",
"returnType" : {
"returnType" : "UpdateKeyDescriptionResult",
"documentation" : null
},
"syncReturnType" : "UpdateKeyDescriptionResult"
}
},
"shapes" : {
"AlgorithmSpec" : {
"c2jName" : "AlgorithmSpec",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"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,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "AlgorithmSpec",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AlgorithmSpec",
"variableName" : "algorithmSpec",
"variableType" : "AlgorithmSpec",
"documentation" : null,
"simpleType" : "AlgorithmSpec",
"variableSetterType" : "AlgorithmSpec"
},
"wrapper" : false
},
"AliasListEntry" : {
"c2jName" : "AliasListEntry",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Contains information about an alias.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"deprecated" : false,
"documentation" : "String that contains the alias.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**String that contains the alias.
\n@param aliasName String that contains the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**String that contains the alias.
\n@return String that contains the alias.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasName",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasName",
"setterDocumentation" : "/**String that contains the alias.
\n@param aliasName String that contains the alias.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**String that contains the alias.
\n@param aliasName String that contains the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "AliasArn",
"c2jShape" : "ArnType",
"deprecated" : false,
"documentation" : "String that contains the key ARN.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasArn",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasArn",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasArn",
"setterDocumentation" : "/**String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "String that contains the key ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "String that contains the key identifier pointed to by the alias.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@param targetKeyId String that contains the key identifier pointed to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@return String that contains the key identifier pointed to by the alias.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "TargetKeyId",
"setterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@param targetKeyId String that contains the key identifier pointed to by the alias.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@param targetKeyId String that contains the key identifier pointed to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "String that contains the key identifier pointed to by the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AliasArn" : {
"c2jName" : "AliasArn",
"c2jShape" : "ArnType",
"deprecated" : false,
"documentation" : "String that contains the key ARN.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasArn",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasArn",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasArn",
"setterDocumentation" : "/**String that contains the key ARN.
\n@param aliasArn String that contains the key ARN.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasArn",
"variableType" : "String",
"documentation" : "String that contains the key ARN.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"AliasName" : {
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"deprecated" : false,
"documentation" : "String that contains the alias.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**String that contains the alias.
\n@param aliasName String that contains the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**String that contains the alias.
\n@return String that contains the alias.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasName",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasName",
"setterDocumentation" : "/**String that contains the alias.
\n@param aliasName String that contains the alias.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**String that contains the alias.
\n@param aliasName String that contains the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"TargetKeyId" : {
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "String that contains the key identifier pointed to by the alias.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@param targetKeyId String that contains the key identifier pointed to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@return String that contains the key identifier pointed to by the alias.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "TargetKeyId",
"setterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@param targetKeyId String that contains the key identifier pointed to by the alias.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**String that contains the key identifier pointed to by the alias.
\n@param targetKeyId String that contains the key identifier pointed to by the alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "String that contains the key identifier pointed to by the alias.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "AliasListEntry",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AliasListEntry",
"variableName" : "aliasListEntry",
"variableType" : "AliasListEntry",
"documentation" : null,
"simpleType" : "AliasListEntry",
"variableSetterType" : "AliasListEntry"
},
"wrapper" : false
},
"AlreadyExistsException" : {
"c2jName" : "AlreadyExistsException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "The request was rejected because it attempted to create a resource that already exists.
",
"enums" : null,
"errorCode" : "AlreadyExistsException",
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"required" : null,
"shapeName" : "AlreadyExistsException",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "AlreadyExistsException",
"variableName" : "alreadyExistsException",
"variableType" : "AlreadyExistsException",
"documentation" : null,
"simpleType" : "AlreadyExistsException",
"variableSetterType" : "AlreadyExistsException"
},
"wrapper" : false
},
"CancelKeyDeletionRequest" : {
"c2jName" : "CancelKeyDeletionRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "CancelKeyDeletion",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CancelKeyDeletion",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@return The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
\n@param keyId The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "CancelKeyDeletionRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CancelKeyDeletionRequest",
"variableName" : "cancelKeyDeletionRequest",
"variableType" : "CancelKeyDeletionRequest",
"documentation" : null,
"simpleType" : "CancelKeyDeletionRequest",
"variableSetterType" : "CancelKeyDeletionRequest"
},
"wrapper" : false
},
"CancelKeyDeletionResult" : {
"c2jName" : "CancelKeyDeletionResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The unique identifier of the master key for which deletion is canceled.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@param keyId The unique identifier of the master key for which deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@return The unique identifier of the master key for which deletion is canceled.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@param keyId The unique identifier of the master key for which deletion is canceled.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@param keyId The unique identifier of the master key for which deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The unique identifier of the master key for which deletion is canceled.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The unique identifier of the master key for which deletion is canceled.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@param keyId The unique identifier of the master key for which deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@return The unique identifier of the master key for which deletion is canceled.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@param keyId The unique identifier of the master key for which deletion is canceled.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The unique identifier of the master key for which deletion is canceled.
\n@param keyId The unique identifier of the master key for which deletion is canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The unique identifier of the master key for which deletion is canceled.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "CancelKeyDeletionResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CancelKeyDeletionResult",
"variableName" : "cancelKeyDeletionResult",
"variableType" : "CancelKeyDeletionResult",
"documentation" : null,
"simpleType" : "CancelKeyDeletionResult",
"variableSetterType" : "CancelKeyDeletionResult"
},
"wrapper" : false
},
"CreateAliasRequest" : {
"c2jName" : "CreateAliasRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "CreateAlias",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateAlias",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"deprecated" : false,
"documentation" : "String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@return String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasName",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasName",
"setterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param targetKeyId An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "TargetKeyId",
"setterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param targetKeyId An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param targetKeyId An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AliasName" : {
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"deprecated" : false,
"documentation" : "String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@return String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasName",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasName",
"setterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"TargetKeyId" : {
"c2jName" : "TargetKeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param targetKeyId An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "TargetKeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "TargetKeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "TargetKeyId",
"setterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param targetKeyId An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param targetKeyId An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "targetKeyId",
"variableType" : "String",
"documentation" : "An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "AliasName", "TargetKeyId" ],
"shapeName" : "CreateAliasRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateAliasRequest",
"variableName" : "createAliasRequest",
"variableType" : "CreateAliasRequest",
"documentation" : null,
"simpleType" : "CreateAliasRequest",
"variableSetterType" : "CreateAliasRequest"
},
"wrapper" : false
},
"CreateAliasResult" : {
"c2jName" : "CreateAliasResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "CreateAliasResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateAliasResult",
"variableName" : "createAliasResult",
"variableType" : "CreateAliasResult",
"documentation" : null,
"simpleType" : "CreateAliasResult",
"variableSetterType" : "CreateAliasResult"
},
"wrapper" : false
},
"CreateGrantRequest" : {
"c2jName" : "CreateGrantRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "CreateGrant",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateGrant",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GranteePrincipal",
"c2jShape" : "PrincipalIdType",
"deprecated" : false,
"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, 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.
",
"enumType" : null,
"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, 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, 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.*/",
"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, 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, 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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GranteePrincipal",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GranteePrincipal",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "GranteePrincipal",
"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, 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, 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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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, 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, 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.*/",
"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, 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"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "RetiringPrincipal",
"c2jShape" : "PrincipalIdType",
"deprecated" : false,
"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.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "RetiringPrincipal",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "RetiringPrincipal",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "RetiringPrincipal",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Operations",
"c2jShape" : "GrantOperationList",
"deprecated" : false,
"documentation" : "A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
",
"enumType" : "GrantOperation",
"fluentSetterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\n@param operations A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"getterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\n@return A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@see GrantOperation*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Operations",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Operations",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantOperation",
"deprecated" : false,
"documentation" : "",
"enumType" : "GrantOperation",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"getterDocumentation" : "/**\n@return \n@see GrantOperation*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member \n@see GrantOperation*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "Operations",
"setterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\n@param operations A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@see GrantOperation*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setOperations(java.util.Collection)} or {@link #withOperations(java.util.Collection)} if you want to override the existing values.
\n@param operations A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Constraints",
"c2jShape" : "GrantConstraints",
"deprecated" : false,
"documentation" : "The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param constraints The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. 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.*/",
"getterDocumentation" : "/**
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@return The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.*/",
"getterModel" : {
"returnType" : "GrantConstraints",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Constraints",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Constraints",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Constraints",
"setterDocumentation" : "/**
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param constraints The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.*/",
"setterModel" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"simple" : false,
"varargSetterDocumentation" : "/**
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param constraints The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. 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.*/",
"variable" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Name",
"c2jShape" : "GrantNameType",
"deprecated" : false,
"documentation" : "A friendly name for identifying the grant. Use this value to prevent 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.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A friendly name for identifying the grant. Use this value to prevent 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 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.*/",
"getterDocumentation" : "/**
A friendly name for identifying the grant. Use this value to prevent 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 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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Name",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Name",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Name",
"setterDocumentation" : "/**
A friendly name for identifying the grant. Use this value to prevent 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 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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
A friendly name for identifying the grant. Use this value to prevent 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 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.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent 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"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"Constraints" : {
"c2jName" : "Constraints",
"c2jShape" : "GrantConstraints",
"deprecated" : false,
"documentation" : "The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param constraints The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. 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.*/",
"getterDocumentation" : "/**
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@return The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.*/",
"getterModel" : {
"returnType" : "GrantConstraints",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Constraints",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Constraints",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Constraints",
"setterDocumentation" : "/**
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param constraints The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.*/",
"setterModel" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"simple" : false,
"varargSetterDocumentation" : "/**
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
\n@param constraints The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. 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.*/",
"variable" : {
"variableDeclarationType" : "GrantConstraints",
"variableName" : "constraints",
"variableType" : "GrantConstraints",
"documentation" : "
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
",
"simpleType" : "GrantConstraints",
"variableSetterType" : "GrantConstraints"
},
"xmlNameSpaceUri" : null
},
"GrantTokens" : {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
},
"GranteePrincipal" : {
"c2jName" : "GranteePrincipal",
"c2jShape" : "PrincipalIdType",
"deprecated" : false,
"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, 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.
",
"enumType" : null,
"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, 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, 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.*/",
"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, 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, 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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GranteePrincipal",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GranteePrincipal",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "GranteePrincipal",
"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, 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, 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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "granteePrincipal",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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, 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, 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.*/",
"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, 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"
},
"xmlNameSpaceUri" : null
},
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@return The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@param keyId The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Name" : {
"c2jName" : "Name",
"c2jShape" : "GrantNameType",
"deprecated" : false,
"documentation" : "A friendly name for identifying the grant. Use this value to prevent 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.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A friendly name for identifying the grant. Use this value to prevent 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 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.*/",
"getterDocumentation" : "/**
A friendly name for identifying the grant. Use this value to prevent 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 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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Name",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Name",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Name",
"setterDocumentation" : "/**
A friendly name for identifying the grant. Use this value to prevent 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 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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
A friendly name for identifying the grant. Use this value to prevent 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 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.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "
A friendly name for identifying the grant. Use this value to prevent 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"
},
"xmlNameSpaceUri" : null
},
"Operations" : {
"c2jName" : "Operations",
"c2jShape" : "GrantOperationList",
"deprecated" : false,
"documentation" : "A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
",
"enumType" : "GrantOperation",
"fluentSetterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\n@param operations A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"getterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\n@return A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@see GrantOperation*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Operations",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Operations",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantOperation",
"deprecated" : false,
"documentation" : "",
"enumType" : "GrantOperation",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"getterDocumentation" : "/**\n@return \n@see GrantOperation*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member \n@see GrantOperation*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "Operations",
"setterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\n@param operations A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@see GrantOperation*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setOperations(java.util.Collection)} or {@link #withOperations(java.util.Collection)} if you want to override the existing values.
\n@param operations A list of operations that the grant permits. The list can contain any combination of one or more of the following values: -
-
-
-
-
-
-
-
-
\n@return Returns a reference to this object so that method calls can be chained together.\n@see GrantOperation*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "operations",
"variableType" : "java.util.List",
"documentation" : "A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
-
-
-
-
-
-
-
-
-
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
},
"RetiringPrincipal" : {
"c2jName" : "RetiringPrincipal",
"c2jShape" : "PrincipalIdType",
"deprecated" : false,
"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.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "RetiringPrincipal",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "RetiringPrincipal",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "RetiringPrincipal",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "retiringPrincipal",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId", "GranteePrincipal" ],
"shapeName" : "CreateGrantRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateGrantRequest",
"variableName" : "createGrantRequest",
"variableType" : "CreateGrantRequest",
"documentation" : null,
"simpleType" : "CreateGrantRequest",
"variableSetterType" : "CreateGrantRequest"
},
"wrapper" : false
},
"CreateGrantResult" : {
"c2jName" : "CreateGrantResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "GrantToken",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantToken",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantToken",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "GrantToken",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GrantId",
"c2jShape" : "GrantIdType",
"deprecated" : false,
"documentation" : "The unique identifier for the grant.
You can use the GrantId
in a subsequent RetireGrant or RevokeGrant operation.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "GrantId",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"GrantId" : {
"c2jName" : "GrantId",
"c2jShape" : "GrantIdType",
"deprecated" : false,
"documentation" : "The unique identifier for the grant.
You can use the GrantId
in a subsequent RetireGrant or RevokeGrant operation.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "GrantId",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
},
"GrantToken" : {
"c2jName" : "GrantToken",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantToken",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantToken",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "GrantToken",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "grantToken",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "CreateGrantResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateGrantResult",
"variableName" : "createGrantResult",
"variableType" : "CreateGrantResult",
"documentation" : null,
"simpleType" : "CreateGrantResult",
"variableSetterType" : "CreateGrantResult"
},
"wrapper" : false
},
"CreateKeyRequest" : {
"c2jName" : "CreateKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "CreateKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.CreateKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "Policy",
"c2jShape" : "PolicyType",
"deprecated" : false,
"documentation" : "The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@return The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Policy",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Policy",
"setterDocumentation" : "/**
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Description",
"c2jShape" : "DescriptionType",
"deprecated" : false,
"documentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Description",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Description",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Description",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "KeyUsage",
"c2jShape" : "KeyUsageType",
"deprecated" : false,
"documentation" : "The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
",
"enumType" : "KeyUsageType",
"fluentSetterDocumentation" : "/**The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@param keyUsage The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType*/",
"getterDocumentation" : "/**
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@return The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@see KeyUsageType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyUsage",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyUsage",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyUsage",
"setterDocumentation" : "/**
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@param keyUsage The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@see KeyUsageType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@param keyUsage The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Origin",
"c2jShape" : "OriginType",
"deprecated" : false,
"documentation" : "The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
",
"enumType" : "OriginType",
"fluentSetterDocumentation" : "/**The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@param origin The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType*/",
"getterDocumentation" : "/**
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@return The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@see OriginType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Origin",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Origin",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Origin",
"setterDocumentation" : "/**
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@param origin The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@see OriginType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@param origin The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "BypassPolicyLockoutSafetyCheck",
"c2jShape" : "BooleanType",
"deprecated" : false,
"documentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 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.*/",
"getterDocumentation" : "/**
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "BypassPolicyLockoutSafetyCheck",
"setterDocumentation" : "/**
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.*/",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"varargSetterDocumentation" : "/**
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 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.*/",
"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 likelihood 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 making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"BypassPolicyLockoutSafetyCheck" : {
"c2jName" : "BypassPolicyLockoutSafetyCheck",
"c2jShape" : "BooleanType",
"deprecated" : false,
"documentation" : "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 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.*/",
"getterDocumentation" : "/**
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "BypassPolicyLockoutSafetyCheck",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "BypassPolicyLockoutSafetyCheck",
"setterDocumentation" : "/**
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.*/",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "bypassPolicyLockoutSafetyCheck",
"variableType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"varargSetterDocumentation" : "/**
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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 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 likelihood 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 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.*/",
"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 likelihood 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 making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlNameSpaceUri" : null
},
"Description" : {
"c2jName" : "Description",
"c2jShape" : "DescriptionType",
"deprecated" : false,
"documentation" : "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Description",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Description",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Description",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
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.*/",
"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"
},
"xmlNameSpaceUri" : null
},
"KeyUsage" : {
"c2jName" : "KeyUsage",
"c2jShape" : "KeyUsageType",
"deprecated" : false,
"documentation" : "The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
",
"enumType" : "KeyUsageType",
"fluentSetterDocumentation" : "/**The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@param keyUsage The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType*/",
"getterDocumentation" : "/**
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@return The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@see KeyUsageType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyUsage",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyUsage",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyUsage",
"setterDocumentation" : "/**
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@param keyUsage The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@see KeyUsageType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
\n@param keyUsage The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption.\n@return Returns a reference to this object so that method calls can be chained together.\n@see KeyUsageType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyUsage",
"variableType" : "String",
"documentation" : "
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Origin" : {
"c2jName" : "Origin",
"c2jShape" : "OriginType",
"deprecated" : false,
"documentation" : "The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
",
"enumType" : "OriginType",
"fluentSetterDocumentation" : "/**The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@param origin The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType*/",
"getterDocumentation" : "/**
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@return The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@see OriginType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Origin",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Origin",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Origin",
"setterDocumentation" : "/**
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@param origin The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@see OriginType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
\n@param origin The source of the CMK's key material. The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@see OriginType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "origin",
"variableType" : "String",
"documentation" : "
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Policy" : {
"c2jName" : "Policy",
"c2jShape" : "PolicyType",
"deprecated" : false,
"documentation" : "The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@return The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Policy",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Policy",
"setterDocumentation" : "/**
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
\n@param policy The key policy to attach to the CMK. If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
-
It must allow the principal making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
-
The principal(s) specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 KiB (32768 bytes).
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "CreateKeyRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateKeyRequest",
"variableName" : "createKeyRequest",
"variableType" : "CreateKeyRequest",
"documentation" : null,
"simpleType" : "CreateKeyRequest",
"variableSetterType" : "CreateKeyRequest"
},
"wrapper" : false
},
"CreateKeyResult" : {
"c2jName" : "CreateKeyResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"deprecated" : false,
"documentation" : "Metadata associated with the CMK.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyMetadata",
"setterDocumentation" : "/**Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.*/",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the CMK.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyMetadata" : {
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"deprecated" : false,
"documentation" : "Metadata associated with the CMK.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyMetadata",
"setterDocumentation" : "/**Metadata associated with the CMK.
\n@param keyMetadata Metadata associated with the CMK.*/",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the CMK.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "CreateKeyResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateKeyResult",
"variableName" : "createKeyResult",
"variableType" : "CreateKeyResult",
"documentation" : null,
"simpleType" : "CreateKeyResult",
"variableSetterType" : "CreateKeyResult"
},
"wrapper" : false
},
"DataKeySpec" : {
"c2jName" : "DataKeySpec",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : [ {
"name" : "AES_256",
"value" : "AES_256"
}, {
"name" : "AES_128",
"value" : "AES_128"
} ],
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "DataKeySpec",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DataKeySpec",
"variableName" : "dataKeySpec",
"variableType" : "DataKeySpec",
"documentation" : null,
"simpleType" : "DataKeySpec",
"variableSetterType" : "DataKeySpec"
},
"wrapper" : false
},
"DecryptRequest" : {
"c2jName" : "DecryptRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "Decrypt",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.Decrypt",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"deprecated" : false,
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**Ciphertext to be decrypted. The blob includes metadata.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Ciphertext to be decrypted. The blob includes metadata.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "CiphertextBlob",
"setterDocumentation" : "/**Ciphertext to be decrypted. The blob includes metadata.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"deprecated" : false,
"documentation" : "The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@param encryptionContext The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@return The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.*/",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : null,
"keyType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "value",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Value",
"setterDocumentation" : "/**\n@param value */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"valueType" : "String",
"entryType" : "Map.Entry",
"keySimple" : true,
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"templateType" : "java.util.Map",
"valueList" : false,
"valueSimple" : true
},
"name" : "EncryptionContext",
"setterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@param encryptionContext The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"varargSetterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@param encryptionContext The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CiphertextBlob" : {
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"deprecated" : false,
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**Ciphertext to be decrypted. The blob includes metadata.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Ciphertext to be decrypted. The blob includes metadata.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "CiphertextBlob",
"setterDocumentation" : "/**Ciphertext to be decrypted. The blob includes metadata.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param ciphertextBlob Ciphertext to be decrypted. The blob includes metadata.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "Ciphertext to be decrypted. The blob includes metadata.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
},
"EncryptionContext" : {
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"deprecated" : false,
"documentation" : "The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@param encryptionContext The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@return The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.*/",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : null,
"keyType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "value",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Value",
"setterDocumentation" : "/**\n@param value */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"valueType" : "String",
"entryType" : "Map.Entry",
"keySimple" : true,
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"templateType" : "java.util.Map",
"valueList" : false,
"valueSimple" : true
},
"name" : "EncryptionContext",
"setterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@param encryptionContext The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"varargSetterDocumentation" : "/**The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
\n@param encryptionContext The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlNameSpaceUri" : null
},
"GrantTokens" : {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "CiphertextBlob" ],
"shapeName" : "DecryptRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DecryptRequest",
"variableName" : "decryptRequest",
"variableType" : "DecryptRequest",
"documentation" : null,
"simpleType" : "DecryptRequest",
"variableSetterType" : "DecryptRequest"
},
"wrapper" : false
},
"DecryptResult" : {
"c2jName" : "DecryptResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@param keyId ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@return ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@param keyId ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@param keyId ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"deprecated" : false,
"documentation" : "Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\n@param plaintext Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Plaintext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Plaintext",
"setterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param plaintext Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\n@param plaintext Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@param keyId ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@return ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@param keyId ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
\n@param keyId ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Plaintext" : {
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"deprecated" : false,
"documentation" : "Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\n@param plaintext Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Plaintext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Plaintext",
"setterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param plaintext Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
\n@param plaintext Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "DecryptResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DecryptResult",
"variableName" : "decryptResult",
"variableType" : "DecryptResult",
"documentation" : null,
"simpleType" : "DecryptResult",
"variableSetterType" : "DecryptResult"
},
"wrapper" : false
},
"DeleteAliasRequest" : {
"c2jName" : "DeleteAliasRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "DeleteAlias",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DeleteAlias",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"deprecated" : false,
"documentation" : "The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@return The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasName",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasName",
"setterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AliasName" : {
"c2jName" : "AliasName",
"c2jShape" : "AliasNameType",
"deprecated" : false,
"documentation" : "The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@return The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AliasName",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AliasName",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AliasName",
"setterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
\n@param aliasName The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "aliasName",
"variableType" : "String",
"documentation" : "The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "AliasName" ],
"shapeName" : "DeleteAliasRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteAliasRequest",
"variableName" : "deleteAliasRequest",
"variableType" : "DeleteAliasRequest",
"documentation" : null,
"simpleType" : "DeleteAliasRequest",
"variableSetterType" : "DeleteAliasRequest"
},
"wrapper" : false
},
"DeleteAliasResult" : {
"c2jName" : "DeleteAliasResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "DeleteAliasResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteAliasResult",
"variableName" : "deleteAliasResult",
"variableType" : "DeleteAliasResult",
"documentation" : null,
"simpleType" : "DeleteAliasResult",
"variableSetterType" : "DeleteAliasResult"
},
"wrapper" : false
},
"DeleteImportedKeyMaterialRequest" : {
"c2jName" : "DeleteImportedKeyMaterialRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "DeleteImportedKeyMaterial",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DeleteImportedKeyMaterial",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The identifier of the CMK whose key material to delete. The CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
-
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "DeleteImportedKeyMaterialRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteImportedKeyMaterialRequest",
"variableName" : "deleteImportedKeyMaterialRequest",
"variableType" : "DeleteImportedKeyMaterialRequest",
"documentation" : null,
"simpleType" : "DeleteImportedKeyMaterialRequest",
"variableSetterType" : "DeleteImportedKeyMaterialRequest"
},
"wrapper" : false
},
"DeleteImportedKeyMaterialResult" : {
"c2jName" : "DeleteImportedKeyMaterialResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "DeleteImportedKeyMaterialResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteImportedKeyMaterialResult",
"variableName" : "deleteImportedKeyMaterialResult",
"variableType" : "DeleteImportedKeyMaterialResult",
"documentation" : null,
"simpleType" : "DeleteImportedKeyMaterialResult",
"variableSetterType" : "DeleteImportedKeyMaterialResult"
},
"wrapper" : false
},
"DependencyTimeoutException" : {
"c2jName" : "DependencyTimeoutException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "The system timed out while trying to fulfill the request. The request can be retried.
",
"enums" : null,
"errorCode" : "DependencyTimeoutException",
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"required" : null,
"shapeName" : "DependencyTimeoutException",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DependencyTimeoutException",
"variableName" : "dependencyTimeoutException",
"variableType" : "DependencyTimeoutException",
"documentation" : null,
"simpleType" : "DependencyTimeoutException",
"variableSetterType" : "DependencyTimeoutException"
},
"wrapper" : false
},
"DescribeKeyRequest" : {
"c2jName" : "DescribeKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "DescribeKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DescribeKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"GrantTokens" : {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
},
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "DescribeKeyRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DescribeKeyRequest",
"variableName" : "describeKeyRequest",
"variableType" : "DescribeKeyRequest",
"documentation" : null,
"simpleType" : "DescribeKeyRequest",
"variableSetterType" : "DescribeKeyRequest"
},
"wrapper" : false
},
"DescribeKeyResult" : {
"c2jName" : "DescribeKeyResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"deprecated" : false,
"documentation" : "Metadata associated with the key.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyMetadata",
"setterDocumentation" : "/**Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.*/",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the key.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyMetadata" : {
"c2jName" : "KeyMetadata",
"c2jShape" : "KeyMetadata",
"deprecated" : false,
"documentation" : "Metadata associated with the key.
",
"enumType" : null,
"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.*/",
"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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyMetadata",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyMetadata",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyMetadata",
"setterDocumentation" : "/**Metadata associated with the key.
\n@param keyMetadata Metadata associated with the key.*/",
"setterModel" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"simple" : false,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "KeyMetadata",
"variableName" : "keyMetadata",
"variableType" : "KeyMetadata",
"documentation" : "Metadata associated with the key.
",
"simpleType" : "KeyMetadata",
"variableSetterType" : "KeyMetadata"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "DescribeKeyResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DescribeKeyResult",
"variableName" : "describeKeyResult",
"variableType" : "DescribeKeyResult",
"documentation" : null,
"simpleType" : "DescribeKeyResult",
"variableSetterType" : "DescribeKeyResult"
},
"wrapper" : false
},
"DisableKeyRequest" : {
"c2jName" : "DisableKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "DisableKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DisableKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@param keyId A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
-
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
-
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "DisableKeyRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisableKeyRequest",
"variableName" : "disableKeyRequest",
"variableType" : "DisableKeyRequest",
"documentation" : null,
"simpleType" : "DisableKeyRequest",
"variableSetterType" : "DisableKeyRequest"
},
"wrapper" : false
},
"DisableKeyResult" : {
"c2jName" : "DisableKeyResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "DisableKeyResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DisableKeyResult",
"variableName" : "disableKeyResult",
"variableType" : "DisableKeyResult",
"documentation" : null,
"simpleType" : "DisableKeyResult",
"variableSetterType" : "DisableKeyResult"
},
"wrapper" : false
},
"DisableKeyRotationRequest" : {
"c2jName" : "DisableKeyRotationRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "DisableKeyRotation",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.DisableKeyRotation",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "DisableKeyRotationRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisableKeyRotationRequest",
"variableName" : "disableKeyRotationRequest",
"variableType" : "DisableKeyRotationRequest",
"documentation" : null,
"simpleType" : "DisableKeyRotationRequest",
"variableSetterType" : "DisableKeyRotationRequest"
},
"wrapper" : false
},
"DisableKeyRotationResult" : {
"c2jName" : "DisableKeyRotationResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "DisableKeyRotationResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DisableKeyRotationResult",
"variableName" : "disableKeyRotationResult",
"variableType" : "DisableKeyRotationResult",
"documentation" : null,
"simpleType" : "DisableKeyRotationResult",
"variableSetterType" : "DisableKeyRotationResult"
},
"wrapper" : false
},
"DisabledException" : {
"c2jName" : "DisabledException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "The request was rejected because the specified key was marked as disabled.
",
"enums" : null,
"errorCode" : "DisabledException",
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"required" : null,
"shapeName" : "DisabledException",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DisabledException",
"variableName" : "disabledException",
"variableType" : "DisabledException",
"documentation" : null,
"simpleType" : "DisabledException",
"variableSetterType" : "DisabledException"
},
"wrapper" : false
},
"EnableKeyRequest" : {
"c2jName" : "EnableKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "EnableKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.EnableKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "EnableKeyRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "EnableKeyRequest",
"variableName" : "enableKeyRequest",
"variableType" : "EnableKeyRequest",
"documentation" : null,
"simpleType" : "EnableKeyRequest",
"variableSetterType" : "EnableKeyRequest"
},
"wrapper" : false
},
"EnableKeyResult" : {
"c2jName" : "EnableKeyResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "EnableKeyResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "EnableKeyResult",
"variableName" : "enableKeyResult",
"variableType" : "EnableKeyResult",
"documentation" : null,
"simpleType" : "EnableKeyResult",
"variableSetterType" : "EnableKeyResult"
},
"wrapper" : false
},
"EnableKeyRotationRequest" : {
"c2jName" : "EnableKeyRotationRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "EnableKeyRotation",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.EnableKeyRotation",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId" ],
"shapeName" : "EnableKeyRotationRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "EnableKeyRotationRequest",
"variableName" : "enableKeyRotationRequest",
"variableType" : "EnableKeyRotationRequest",
"documentation" : null,
"simpleType" : "EnableKeyRotationRequest",
"variableSetterType" : "EnableKeyRotationRequest"
},
"wrapper" : false
},
"EnableKeyRotationResult" : {
"c2jName" : "EnableKeyRotationResult",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : null,
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "EnableKeyRotationResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "EnableKeyRotationResult",
"variableName" : "enableKeyRotationResult",
"variableType" : "EnableKeyRotationResult",
"documentation" : null,
"simpleType" : "EnableKeyRotationResult",
"variableSetterType" : "EnableKeyRotationResult"
},
"wrapper" : false
},
"EncryptRequest" : {
"c2jName" : "EncryptRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "Encrypt",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.Encrypt",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"deprecated" : false,
"documentation" : "Data to be encrypted.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**Data to be encrypted.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Data to be encrypted.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Plaintext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Plaintext",
"setterDocumentation" : "/**Data to be encrypted.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param plaintext Data to be encrypted.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "Data to be encrypted.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"deprecated" : false,
"documentation" : "Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@param encryptionContext Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@return Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.*/",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : null,
"keyType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "value",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Value",
"setterDocumentation" : "/**\n@param value */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"valueType" : "String",
"entryType" : "Map.Entry",
"keySimple" : true,
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"templateType" : "java.util.Map",
"valueList" : false,
"valueSimple" : true
},
"name" : "EncryptionContext",
"setterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@param encryptionContext Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"varargSetterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@param encryptionContext Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"EncryptionContext" : {
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"deprecated" : false,
"documentation" : "Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@param encryptionContext Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@return Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.*/",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : null,
"keyType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "value",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Value",
"setterDocumentation" : "/**\n@param value */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"valueType" : "String",
"entryType" : "Map.Entry",
"keySimple" : true,
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"templateType" : "java.util.Map",
"valueList" : false,
"valueSimple" : true
},
"name" : "EncryptionContext",
"setterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@param encryptionContext Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"varargSetterDocumentation" : "/**Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
\n@param encryptionContext Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt
API or decryption will fail. For more information, see Encryption Context.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlNameSpaceUri" : null
},
"GrantTokens" : {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
},
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Plaintext" : {
"c2jName" : "Plaintext",
"c2jShape" : "PlaintextType",
"deprecated" : false,
"documentation" : "Data to be encrypted.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**Data to be encrypted.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return Data to be encrypted.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Plaintext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Plaintext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Plaintext",
"setterDocumentation" : "/**Data to be encrypted.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param plaintext Data to be encrypted.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**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.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "plaintext",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "Data to be encrypted.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "KeyId", "Plaintext" ],
"shapeName" : "EncryptRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "EncryptRequest",
"variableName" : "encryptRequest",
"variableType" : "EncryptRequest",
"documentation" : null,
"simpleType" : "EncryptRequest",
"variableSetterType" : "EncryptRequest"
},
"wrapper" : false
},
"EncryptResult" : {
"c2jName" : "EncryptResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"deprecated" : false,
"documentation" : "The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\n@param ciphertextBlob The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "CiphertextBlob",
"setterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param ciphertextBlob The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\n@param ciphertextBlob The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The ID of the key used during encryption.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The ID of the key used during encryption.
\n@param keyId The ID of the key used during encryption.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The ID of the key used during encryption.
\n@return The ID of the key used during encryption.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The ID of the key used during encryption.
\n@param keyId The ID of the key used during encryption.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The ID of the key used during encryption.
\n@param keyId The ID of the key used during encryption.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The ID of the key used during encryption.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CiphertextBlob" : {
"c2jName" : "CiphertextBlob",
"c2jShape" : "CiphertextType",
"deprecated" : false,
"documentation" : "The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\n@param ciphertextBlob The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.*/",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "CiphertextBlob",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "CiphertextBlob",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "CiphertextBlob",
"setterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\nAWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param ciphertextBlob The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.*/",
"setterModel" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"simple" : true,
"varargSetterDocumentation" : "/**The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
\n@param ciphertextBlob The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "ciphertextBlob",
"variableType" : "java.nio.ByteBuffer",
"documentation" : "The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
",
"simpleType" : "ByteBuffer",
"variableSetterType" : "java.nio.ByteBuffer"
},
"xmlNameSpaceUri" : null
},
"KeyId" : {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "The ID of the key used during encryption.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The ID of the key used during encryption.
\n@param keyId The ID of the key used during encryption.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The ID of the key used during encryption.
\n@return The ID of the key used during encryption.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**The ID of the key used during encryption.
\n@param keyId The ID of the key used during encryption.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The ID of the key used during encryption.
\n@param keyId The ID of the key used during encryption.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "The ID of the key used during encryption.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "EncryptResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "EncryptResult",
"variableName" : "encryptResult",
"variableType" : "EncryptResult",
"documentation" : null,
"simpleType" : "EncryptResult",
"variableSetterType" : "EncryptResult"
},
"wrapper" : false
},
"ExpirationModelType" : {
"c2jName" : "ExpirationModelType",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : [ {
"name" : "KEY_MATERIAL_EXPIRES",
"value" : "KEY_MATERIAL_EXPIRES"
}, {
"name" : "KEY_MATERIAL_DOES_NOT_EXPIRE",
"value" : "KEY_MATERIAL_DOES_NOT_EXPIRE"
} ],
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "ExpirationModelType",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ExpirationModelType",
"variableName" : "expirationModelType",
"variableType" : "ExpirationModelType",
"documentation" : null,
"simpleType" : "ExpirationModelType",
"variableSetterType" : "ExpirationModelType"
},
"wrapper" : false
},
"ExpiredImportTokenException" : {
"c2jName" : "ExpiredImportTokenException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "The request was rejected because the provided import token is expired. Use GetParametersForImport to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
",
"enums" : null,
"errorCode" : "ExpiredImportTokenException",
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"required" : null,
"shapeName" : "ExpiredImportTokenException",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "ExpiredImportTokenException",
"variableName" : "expiredImportTokenException",
"variableType" : "ExpiredImportTokenException",
"documentation" : null,
"simpleType" : "ExpiredImportTokenException",
"variableSetterType" : "ExpiredImportTokenException"
},
"wrapper" : false
},
"GenerateDataKeyRequest" : {
"c2jName" : "GenerateDataKeyRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "GenerateDataKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TrentService.GenerateDataKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "KeyId",
"c2jShape" : "KeyIdType",
"deprecated" : false,
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"enumType" : null,
"fluentSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeyId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeyId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeyId",
"setterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@param keyId A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\". -
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keyId",
"variableType" : "String",
"documentation" : "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"deprecated" : false,
"documentation" : "Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@param encryptionContext Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@return Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.*/",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : null,
"keyType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "value",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Value",
"setterDocumentation" : "/**\n@param value */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"valueType" : "String",
"entryType" : "Map.Entry",
"keySimple" : true,
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"templateType" : "java.util.Map",
"valueList" : false,
"valueSimple" : true
},
"name" : "EncryptionContext",
"setterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@param encryptionContext Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"varargSetterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@param encryptionContext Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "NumberOfBytes",
"c2jShape" : "NumberOfBytesType",
"deprecated" : false,
"documentation" : "Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.
\n@param numberOfBytes Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.
\n@return Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.*/",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "NumberOfBytes",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "NumberOfBytes",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "NumberOfBytes",
"setterDocumentation" : "/**Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.
\n@param numberOfBytes Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.*/",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "numberOfBytes",
"variableType" : "Integer",
"documentation" : "",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"varargSetterDocumentation" : "/**Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.
\n@param numberOfBytes Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "numberOfBytes",
"variableType" : "Integer",
"documentation" : "Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec
parameter instead.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "KeySpec",
"c2jShape" : "DataKeySpec",
"deprecated" : false,
"documentation" : "Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
",
"enumType" : "DataKeySpec",
"fluentSetterDocumentation" : "/**Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
\n@param keySpec Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.\n@return Returns a reference to this object so that method calls can be chained together.\n@see DataKeySpec*/",
"getterDocumentation" : "/**Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
\n@return Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.\n@see DataKeySpec*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "KeySpec",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "KeySpec",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "KeySpec",
"setterDocumentation" : "/**Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
\n@param keySpec Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.\n@see DataKeySpec*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "keySpec",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
\n@param keySpec Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.\n@return Returns a reference to this object so that method calls can be chained together.\n@see DataKeySpec*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "keySpec",
"variableType" : "String",
"documentation" : "Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "GrantTokens",
"c2jShape" : "GrantTokenList",
"deprecated" : false,
"documentation" : "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
",
"enumType" : null,
"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.*/",
"getterDocumentation" : "/**
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\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,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "GrantTokens",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "GrantTokens",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "com.amazonaws.internal.SdkInternalList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "GrantTokenType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "com.amazonaws.internal.SdkInternalList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "GrantTokens",
"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.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"variableName" : "grantTokens",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setGrantTokens(java.util.Collection)} or {@link #withGrantTokens(java.util.Collection)} if you want to override the existing values.
\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.*/",
"variable" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalList",
"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"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"EncryptionContext" : {
"c2jName" : "EncryptionContext",
"c2jShape" : "EncryptionContextType",
"deprecated" : false,
"documentation" : "Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@param encryptionContext Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@return Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.*/",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "EncryptionContext",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "EncryptionContext",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "com.amazonaws.internal.SdkInternalMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : null,
"keyType" : "String",
"valueLocationName" : "value",
"valueModel" : {
"c2jName" : "value",
"c2jShape" : "EncryptionContextValue",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "value",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Value",
"setterDocumentation" : "/**\n@param value */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param value \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"valueType" : "String",
"entryType" : "Map.Entry",
"keySimple" : true,
"templateImplType" : "com.amazonaws.internal.SdkInternalMap",
"templateType" : "java.util.Map",
"valueList" : false,
"valueSimple" : true
},
"name" : "EncryptionContext",
"setterDocumentation" : "/**Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
\n@param encryptionContext Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.*/",
"setterModel" : {
"variableDeclarationType" : "com.amazonaws.internal.SdkInternalMap",
"variableName" : "encryptionContext",
"variableType" : "java.util.Map",
"documentation" : "",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map