get_account

APIGateway.Client.get_account()

Gets information about the current Account resource.

See also: AWS API Documentation

Request Syntax

response = client.get_account()

Return type

dict

Returns

Response Syntax

{
    'cloudwatchRoleArn': 'string',
    'throttleSettings': {
        'burstLimit': 123,
        'rateLimit': 123.0
    },
    'features': [
        'string',
    ],
    'apiKeyVersion': 'string'
}

Response Structure

• (dict) --

  Represents an AWS account that is associated with API Gateway.

  • cloudwatchRoleArn (string) --

    The ARN of an Amazon CloudWatch role for the current Account.

  • throttleSettings (dict) --

    Specifies the API request limits configured for the current Account.

    • burstLimit (integer) --

      The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

    • rateLimit (float) --

      The API target request rate limit.

  • features (list) --

    A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans" .

    • (string) --
  • apiKeyVersion (string) --

    The version of the API keys used for the account.

Exceptions

• APIGateway.Client.exceptions.BadRequestException
• APIGateway.Client.exceptions.NotFoundException
• APIGateway.Client.exceptions.UnauthorizedException
• APIGateway.Client.exceptions.TooManyRequestsException