/AWS1/CL_LOCDESCRKEYRESPONSE¶
DescribeKeyResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_key TYPE /AWS1/LOCAPIKEY /AWS1/LOCAPIKEY¶
The key value/string of an API key.
iv_keyarn TYPE /AWS1/LOCARN /AWS1/LOCARN¶
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
iv_keyname TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME¶
The name of the API key resource.
io_restrictions TYPE REF TO /AWS1/CL_LOCAPIKEYRESTRICTIONS /AWS1/CL_LOCAPIKEYRESTRICTIONS¶
Restrictions
iv_createtime TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP¶
The timestamp for when the API key resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
iv_expiretime TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP¶
The timestamp for when the API key resource will expire in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
iv_updatetime TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP¶
The timestamp for when the API key resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Optional arguments:¶
iv_description TYPE /AWS1/LOCRESOURCEDESCRIPTION /AWS1/LOCRESOURCEDESCRIPTION¶
The optional description for the API key resource.
it_tags TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
Tags associated with the API key resource.
Queryable Attributes¶
Key¶
The key value/string of an API key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEY() |
Getter for KEY, with configurable default |
ASK_KEY() |
Getter for KEY w/ exceptions if field has no value |
HAS_KEY() |
Determine if KEY has a value |
KeyArn¶
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
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYARN() |
Getter for KEYARN, with configurable default |
ASK_KEYARN() |
Getter for KEYARN w/ exceptions if field has no value |
HAS_KEYARN() |
Determine if KEYARN has a value |
KeyName¶
The name of the API key resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYNAME() |
Getter for KEYNAME, with configurable default |
ASK_KEYNAME() |
Getter for KEYNAME w/ exceptions if field has no value |
HAS_KEYNAME() |
Determine if KEYNAME has a value |
Restrictions¶
Restrictions
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESTRICTIONS() |
Getter for RESTRICTIONS |
CreateTime¶
The timestamp for when the API key resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATETIME() |
Getter for CREATETIME, with configurable default |
ASK_CREATETIME() |
Getter for CREATETIME w/ exceptions if field has no value |
HAS_CREATETIME() |
Determine if CREATETIME has a value |
ExpireTime¶
The timestamp for when the API key resource will expire in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRETIME() |
Getter for EXPIRETIME, with configurable default |
ASK_EXPIRETIME() |
Getter for EXPIRETIME w/ exceptions if field has no value |
HAS_EXPIRETIME() |
Determine if EXPIRETIME has a value |
UpdateTime¶
The timestamp for when the API key resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATETIME() |
Getter for UPDATETIME, with configurable default |
ASK_UPDATETIME() |
Getter for UPDATETIME w/ exceptions if field has no value |
HAS_UPDATETIME() |
Determine if UPDATETIME has a value |
Description¶
The optional description for the API key resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Tags¶
Tags associated with the API key resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |