@aws-sdk/client-location

DescribeKeyCommandOutput Interface

The output of DescribeKeyCommand.

Members

Name
Type
Details
$metadata RequiredResponseMetadata
Metadata pertaining to this request.
CreateTime RequiredDate | undefined

The timestamp for when the API key resource was created in ISO 8601  format: YYYY-MM-DDThh:mm:ss.sssZ.

ExpireTime RequiredDate | undefined

The timestamp for when the API key resource will expire in ISO 8601  format: YYYY-MM-DDThh:mm:ss.sssZ.

Key Requiredstring | undefined

The key value/string of an API key.

KeyArn Requiredstring | undefined

The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

  • Format example: arn:aws:geo:region:account-id:key/ExampleKey

KeyName Requiredstring | undefined

The name of the API key resource.

Restrictions RequiredApiKeyRestrictions | undefined

API Restrictions on the allowed actions, resources, and referers for an API key resource.

UpdateTime RequiredDate | undefined

The timestamp for when the API key resource was last updated in ISO 8601  format: YYYY-MM-DDThh:mm:ss.sssZ.

Description string | undefined

The optional description for the API key resource.

Tags Record<string, string> | undefined

Tags associated with the API key resource.

Full Signature

export interface DescribeKeyCommandOutput extends DescribeKeyResponse, MetadataBearer