GlobalAccelerator / Client / describe_accelerator_attributes

describe_accelerator_attributes#

GlobalAccelerator.Client.describe_accelerator_attributes(**kwargs)#

Describe the attributes of an accelerator.

See also: AWS API Documentation

Request Syntax

response = client.describe_accelerator_attributes(
    AcceleratorArn='string'
)
Parameters:

AcceleratorArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'AcceleratorAttributes': {
        'FlowLogsEnabled': True|False,
        'FlowLogsS3Bucket': 'string',
        'FlowLogsS3Prefix': 'string'
    }
}

Response Structure

  • (dict) –

    • AcceleratorAttributes (dict) –

      The attributes of the accelerator.

      • FlowLogsEnabled (boolean) –

        Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

        For more information, see Flow logs in the Global Accelerator Developer Guide .

      • FlowLogsS3Bucket (string) –

        The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.

      • FlowLogsS3Prefix (string) –

        The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .

        If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

        s3-bucket_name//AWSLogs/aws_account_id

Exceptions

  • GlobalAccelerator.Client.exceptions.AcceleratorNotFoundException

  • GlobalAccelerator.Client.exceptions.InternalServiceErrorException

  • GlobalAccelerator.Client.exceptions.InvalidArgumentException