ConfigService / Client / put_aggregation_authorization

put_aggregation_authorization#

ConfigService.Client.put_aggregation_authorization(**kwargs)#

Authorizes the aggregator account and region to collect data from the source account and region.

Note

Tags are added at creation and cannot be updated with this operation

PutAggregationAuthorization is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

Use TagResource and UntagResource to update tags after creation.

See also: AWS API Documentation

Request Syntax

response = client.put_aggregation_authorization(
    AuthorizedAccountId='string',
    AuthorizedAwsRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • AuthorizedAccountId (string) –

    [REQUIRED]

    The 12-digit account ID of the account authorized to aggregate data.

  • AuthorizedAwsRegion (string) –

    [REQUIRED]

    The region authorized to collect aggregated data.

  • Tags (list) –

    An array of tag object.

    • (dict) –

      The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • Key (string) –

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value (string) –

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'AggregationAuthorization': {
        'AggregationAuthorizationArn': 'string',
        'AuthorizedAccountId': 'string',
        'AuthorizedAwsRegion': 'string',
        'CreationTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • AggregationAuthorization (dict) –

      Returns an AggregationAuthorization object.

      • AggregationAuthorizationArn (string) –

        The Amazon Resource Name (ARN) of the aggregation object.

      • AuthorizedAccountId (string) –

        The 12-digit account ID of the account authorized to aggregate data.

      • AuthorizedAwsRegion (string) –

        The region authorized to collect aggregated data.

      • CreationTime (datetime) –

        The time stamp when the aggregation authorization was created.

Exceptions

  • ConfigService.Client.exceptions.InvalidParameterValueException