GlobalAccelerator / Client / list_cross_account_resources

list_cross_account_resources#

GlobalAccelerator.Client.list_cross_account_resources(**kwargs)#

List the cross-account resources available to work with.

See also: AWS API Documentation

Request Syntax

response = client.list_cross_account_resources(
    AcceleratorArn='string',
    ResourceOwnerAwsAccountId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AcceleratorArn (string) – The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.

  • ResourceOwnerAwsAccountId (string) –

    [REQUIRED]

    The account ID of a resource owner in a cross-account attachment.

  • MaxResults (integer) – The number of cross-account resource 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

{
    'CrossAccountResources': [
        {
            'EndpointId': 'string',
            'Cidr': 'string',
            'AttachmentArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • CrossAccountResources (list) –

      The cross-account resources used with an accelerator.

      • (dict) –

        An endpoint (Amazon Web Services resource) or an IP address range, in CIDR format, that is listed in a cross-account attachment. A cross-account resource can be added to an accelerator by specified principals, which are also listed in the attachment.

        For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

        • EndpointId (string) –

          The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.

        • Cidr (string) –

          An IP address range, in CIDR format, that is specified as an Amazon Web Services 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.

        • AttachmentArn (string) –

          The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or CIDR range) that can be added to accelerators and principals that have permission to add them.

    • NextToken (string) –

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

Exceptions