ElasticInference / Client / describe_accelerator_offerings

describe_accelerator_offerings#

ElasticInference.Client.describe_accelerator_offerings(**kwargs)#

Describes the locations in which a given accelerator type or set of types is present in a given region.

See also: AWS API Documentation

Request Syntax

response = client.describe_accelerator_offerings(
    locationType='region'|'availability-zone'|'availability-zone-id',
    acceleratorTypes=[
        'string',
    ]
)
Parameters:

  • locationType (string) –

    [REQUIRED]

    The location type that you want to describe accelerator type offerings for. It can assume the following values: region: will return the accelerator type offering at the regional level. availability-zone: will return the accelerator type offering at the availability zone level. availability-zone-id: will return the accelerator type offering at the availability zone level returning the availability zone id.

  • acceleratorTypes (list) –

    The list of accelerator types to describe.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'acceleratorTypeOfferings': [
        {
            'acceleratorType': 'string',
            'locationType': 'region'|'availability-zone'|'availability-zone-id',
            'location': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • acceleratorTypeOfferings (list) –

      The list of accelerator type offerings for a specific location.

      • (dict) –

        The offering for an Elastic Inference Accelerator type.

        • acceleratorType (string) –

          The name of the Elastic Inference Accelerator type.

        • locationType (string) –

          The location type for the offering. It can assume the following values: region: defines that the offering is at the regional level. availability-zone: defines that the offering is at the availability zone level. availability-zone-id: defines that the offering is at the availability zone level, defined by the availability zone id.

        • location (string) –

          The location for the offering. It will return either the region, availability zone or availability zone id for the offering depending on the locationType value.

Exceptions

  • ElasticInference.Client.exceptions.BadRequestException

  • ElasticInference.Client.exceptions.ResourceNotFoundException

  • ElasticInference.Client.exceptions.InternalServerException