Skip to content

UpdateKeyRequest

Source code in docs_src/capo_location/types/update_key_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class UpdateKeyRequest(TypedDict, closed=True):
    key_name: "capo_location.types.resource_name.ResourceName"
    """<p>The name of the API key resource to update.</p>"""
    description: NotRequired[
        "capo_location.types.resource_description.ResourceDescription"
    ]
    """<p>Updates the description for the API key resource.</p>"""
    expire_time: NotRequired["capo_location.types.timestamp.Timestamp"]
    """<p>Updates 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>"""
    no_expiry: NotRequired["bool"]
    """<p>Whether the API key should expire. Set to <code>true</code> to set the API key to have no expiration time.</p>"""
    force_update: NotRequired["bool"]
    """<p>The boolean flag to be included for updating <code>ExpireTime</code> or <code>Restrictions</code> details.</p> <p>Must be set to <code>true</code> to update an API key resource that has been used in the past 7 days.</p> <p> <code>False</code> if force update is not preferred</p> <p>Default value: <code>False</code> </p>"""
    restrictions: NotRequired[
        "capo_location.types.api_key_restrictions.ApiKeyRestrictions"
    ]
    """<p>Updates the API key restrictions for the API key resource.</p>"""

description instance-attribute 

description: NotRequired[ResourceDescription]

Updates the description for the API key resource.

expire_time instance-attribute 

expire_time: NotRequired[Timestamp]

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

force_update instance-attribute 

force_update: NotRequired[bool]

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

key_name instance-attribute 

key_name: ResourceName

The name of the API key resource to update.

no_expiry instance-attribute 

no_expiry: NotRequired[bool]

Whether the API key should expire. Set to true to set the API key to have no expiration time.

restrictions instance-attribute 

restrictions: NotRequired[ApiKeyRestrictions]

Updates the API key restrictions for the API key resource.