GlobalAccelerator / Client / list_cross_account_attachments

list_cross_account_attachments#

GlobalAccelerator.Client.list_cross_account_attachments(**kwargs)#

List the cross-account attachments that have been created in Global Accelerator.

See also: AWS API Documentation

Request Syntax

response = client.list_cross_account_attachments(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The number of cross-account attachment objects that you want to return with this call. The default value is 10.

  • NextToken (string) – The token for the next set of results. You receive this token from a previous call.

Return type:

dict

Returns:

Response Syntax

{
    'CrossAccountAttachments': [
        {
            'AttachmentArn': 'string',
            'Name': 'string',
            'Principals': [
                'string',
            ],
            'Resources': [
                {
                    'EndpointId': 'string',
                    'Cidr': 'string',
                    'Region': 'string'
                },
            ],
            'LastModifiedTime': datetime(2015, 1, 1),
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CrossAccountAttachments (list) –

      Information about the cross-account attachments.

      • (dict) –

        A cross-account attachment in Global Accelerator. A cross-account attachment specifies the principals who have permission to work with resources in your account, which you also list in the attachment.

        • AttachmentArn (string) –

          The Amazon Resource Name (ARN) of the cross-account attachment.

        • Name (string) –

          The name of the cross-account attachment.

        • Principals (list) –

          The principals included in the cross-account attachment.

          • (string) –

        • Resources (list) –

          The resources included in the cross-account attachment.

          • (dict) –

            A resource is one of the following: the ARN for an Amazon Web Services resource that is supported by Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.

            • EndpointId (string) –

              The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.

              An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.

            • Cidr (string) –

              An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator

              For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

            • Region (string) –

              The Amazon Web Services Region where a shared endpoint resource is located.

        • LastModifiedTime (datetime) –

          The date and time that the cross-account attachment was last modified.

        • CreatedTime (datetime) –

          The date and time that the cross-account attachment was created.

    • NextToken (string) –

      The token for the next set of results. You receive this token from a previous call.

Exceptions