Skip to content

DescribeKeyResponse

Source code in docs_src/capo_location/types/describe_key_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class DescribeKeyResponse(TypedDict, closed=True):
    key: "capo_location.types.api_key.ApiKey"
    """<p>The key value/string of an API key.</p>"""
    key_arn: "capo_location.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.</p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:key/ExampleKey</code> </p> </li> </ul>"""
    key_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the API key resource.</p>"""
    restrictions: "capo_location.types.api_key_restrictions.ApiKeyRestrictions"
    create_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the API key resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>"""
    expire_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>"""
    update_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp for when the API key resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>"""
    description: NotRequired[
        "capo_location.types.resource_description.ResourceDescription"
    ]
    """<p>The optional description for the API key resource.</p>"""
    tags: NotRequired["capo_location.types.tag_map.TagMap"]
    """<p>Tags associated with the API key resource.</p>"""

create_time instance-attribute 

create_time: Timestamp

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

description instance-attribute 

description: NotRequired[ResourceDescription]

The optional description for the API key resource.

expire_time instance-attribute 

expire_time: Timestamp

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

key instance-attribute 

key: ApiKey

The key value/string of an API key.

key_arn instance-attribute 

key_arn: Arn

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

key_name instance-attribute 

key_name: ResourceName

The name of the API key resource.

restrictions instance-attribute 

restrictions: ApiKeyRestrictions

tags instance-attribute 

tags: NotRequired[TagMap]

Tags associated with the API key resource.

update_time instance-attribute 

update_time: Timestamp

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