Outposts / Client / update_outpost

update_outpost#

Outposts.Client.update_outpost(**kwargs)#

Updates an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.update_outpost(
    OutpostId='string',
    Name='string',
    Description='string',
    SupportedHardwareType='RACK'|'SERVER'
)
Parameters:

  • OutpostId (string) –

    [REQUIRED]

    The ID or the Amazon Resource Name (ARN) of the Outpost.

  • Name (string) – The name of the Outpost.

  • Description (string) – The description of the Outpost.

  • SupportedHardwareType (string) – The type of hardware for this Outpost.

Return type:

dict

Returns:

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER'
    }
}

Response Structure

  • (dict) –

    • Outpost (dict) –

      Information about an Outpost.

      • OutpostId (string) –

        The ID of the Outpost.

      • OwnerId (string) –

        The Amazon Web Services account ID of the Outpost owner.

      • OutpostArn (string) –

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId (string) –

        The ID of the site.

      • Name (string) –

        The name of the Outpost.

      • Description (string) –

        The description of the Outpost.

      • LifeCycleStatus (string) –

        The life cycle status.

      • AvailabilityZone (string) –

        The Availability Zone.

      • AvailabilityZoneId (string) –

        The ID of the Availability Zone.

      • Tags (dict) –

        The Outpost tags.

        • (string) –

          • (string) –

      • SiteArn (string) –

        The Amazon Resource Name (ARN) of the site.

      • SupportedHardwareType (string) –

        The hardware type.

Exceptions

  • Outposts.Client.exceptions.ValidationException

  • Outposts.Client.exceptions.ConflictException

  • Outposts.Client.exceptions.NotFoundException

  • Outposts.Client.exceptions.AccessDeniedException

  • Outposts.Client.exceptions.InternalServerException