AWS Artifact

List active customer-agreements applicable to calling identity.

See also: AWS API Documentation

Request Syntax

client.list_customer_agreements(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

Maximum number of resources to return in the paginated response.

type nextToken:

string

param nextToken:

Pagination token to request the next page of resources.

rtype:

dict

returns:

Response Syntax

{
    'customerAgreements': [
        {
            'name': 'string',
            'arn': 'string',
            'id': 'string',
            'agreementArn': 'string',
            'awsAccountId': 'string',
            'organizationArn': 'string',
            'effectiveStart': datetime(2015, 1, 1),
            'effectiveEnd': datetime(2015, 1, 1),
            'state': 'ACTIVE'|'CUSTOMER_TERMINATED'|'AWS_TERMINATED',
            'description': 'string',
            'acceptanceTerms': [
                'string',
            ],
            'terminateTerms': [
                'string',
            ],
            'type': 'CUSTOM'|'DEFAULT'|'MODIFIED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • customerAgreements (list) --

    List of customer-agreement resources.

    • (dict) --

      Summary for customer-agreement resource.

      • name (string) --

        Name of the customer-agreement resource.

      • arn (string) --

        ARN of the customer-agreement resource.

      • id (string) --

        Identifier of the customer-agreement resource.

      • agreementArn (string) --

        ARN of the agreement resource the customer-agreement resource represents.

      • awsAccountId (string) --

        AWS account Id that owns the resource.

      • organizationArn (string) --

        ARN of the organization that owns the resource.

      • effectiveStart (datetime) --

        Timestamp indicating when the agreement became effective.

      • effectiveEnd (datetime) --

        Timestamp indicating when the agreement was terminated.

      • state (string) --

        State of the resource.

      • description (string) --

        Description of the resource.

      • acceptanceTerms (list) --

        Terms required to accept the agreement resource.

        • (string) --

      • terminateTerms (list) --

        Terms required to terminate the customer-agreement resource.

        • (string) --

      • type (string) --

        Type of the customer-agreement resource.

  • nextToken (string) --

    Pagination token to request the next page of resources.