EC2 / Client / describe_transit_gateway_metering_policies

describe_transit_gateway_metering_policies

EC2.Client.describe_transit_gateway_metering_policies(**kwargs)

Describes one or more transit gateway metering policies.

See also: AWS API Documentation

Request Syntax

response = client.describe_transit_gateway_metering_policies(
    TransitGatewayMeteringPolicyIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• TransitGatewayMeteringPolicyIds (list) –

  The IDs of the transit gateway metering policies to describe.

  • (string) –

• Filters (list) –

  One or more filters to apply when describing transit gateway metering policies.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayMeteringPolicies': [
        {
            'TransitGatewayMeteringPolicyId': 'string',
            'TransitGatewayId': 'string',
            'MiddleboxAttachmentIds': [
                'string',
            ],
            'State': 'available'|'deleted'|'pending'|'modifying'|'deleting',
            'UpdateEffectiveAt': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • TransitGatewayMeteringPolicies (list) –

    Information about the transit gateway metering policies.

    • (dict) –

      Describes a transit gateway metering policy.

      • TransitGatewayMeteringPolicyId (string) –

        The ID of the transit gateway metering policy.

      • TransitGatewayId (string) –

        The ID of the transit gateway associated with the metering policy.

      • MiddleboxAttachmentIds (list) –

        The IDs of the middlebox attachments associated with the metering policy.

        • (string) –

      • State (string) –

        The state of the transit gateway metering policy.

      • UpdateEffectiveAt (datetime) –

        The date and time when the metering policy update becomes effective.

      • Tags (list) –

        The tags assigned to the transit gateway metering policy.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.