Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetEncryptionKey

Gets an encryption key.

Request Syntax


GET /encryptionkey/get?resourceType=resourceType&scanType=scanType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceType

The resource type the key encrypts.

Valid Values: AWS_EC2_INSTANCE | AWS_ECR_CONTAINER_IMAGE | AWS_ECR_REPOSITORY | AWS_LAMBDA_FUNCTION

Required: Yes

scanType

The scan type the key encrypts.

Valid Values: NETWORK | PACKAGE | CODE

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "kmsKeyId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

kmsKeyId

A kms key ID.

Type: String

Pattern: ^arn:aws(-(us-gov|cn))?:kms:([a-z0-9][-.a-z0-9]{0,62})?:[0-9]{12}?:key/(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(mrk-[0-9a-zA-Z]{32}))$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

HTTP Status Code: 400