ElasticInference / Client / describe_accelerators

describe_accelerators#

ElasticInference.Client.describe_accelerators(**kwargs)#

Describes information over a provided set of accelerators belonging to an account.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

See also: AWS API Documentation

Request Syntax

response = client.describe_accelerators(
    acceleratorIds=[
        'string',
    ],
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters:

  • acceleratorIds (list) –

    The IDs of the accelerators to describe.

    • (string) –

  • filters (list) –

    One or more filters. Filter names and values are case-sensitive. Valid filter names are: accelerator-types: can provide a list of accelerator type names to filter for. instance-id: can provide a list of EC2 instance ids to filter for.

    • (dict) –

      A filter expression for the Elastic Inference Accelerator list.

      • name (string) –

        The filter name for the Elastic Inference Accelerator list. It can assume the following values: accelerator-type: the type of Elastic Inference Accelerator to filter for. instance-id: an EC2 instance id to filter for.

      • values (list) –

        The values for the filter of the Elastic Inference Accelerator list.

        • (string) –

  • maxResults (integer) – The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

  • nextToken (string) – A token to specify where to start paginating. This is the NextToken from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'acceleratorSet': [
        {
            'acceleratorHealth': {
                'status': 'string'
            },
            'acceleratorType': 'string',
            'acceleratorId': 'string',
            'availabilityZone': 'string',
            'attachedResource': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • acceleratorSet (list) –

      The details of the Elastic Inference Accelerators.

      • (dict) –

        The details of an Elastic Inference Accelerator.

        • acceleratorHealth (dict) –

          The health of the Elastic Inference Accelerator.

          • status (string) –

            The health status of the Elastic Inference Accelerator.

        • acceleratorType (string) –

          The type of the Elastic Inference Accelerator.

        • acceleratorId (string) –

          The ID of the Elastic Inference Accelerator.

        • availabilityZone (string) –

          The availability zone where the Elastic Inference Accelerator is present.

        • attachedResource (string) –

          The ARN of the resource that the Elastic Inference Accelerator is attached to.

    • nextToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

Exceptions