Interconnect / Client / list_attach_points

list_attach_points¶

Interconnect.Client.list_attach_points(**kwargs)¶

Lists all Attach Points the caller has access to that are valid for the specified Environment.

Request Syntax

response = client.list_attach_points(
    environmentId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

environmentId (string) –
[REQUIRED]

The identifier of the Environment for which to list valid Attach Points.
maxResults (integer) – The max number of list results in a single paginated response.
nextToken (string) – A pagination token from a previous paginated response indicating you wish to get the next page.

Return type:

dict

Returns:

Response Syntax

{
    'attachPoints': [
        {
            'type': 'DirectConnectGateway',
            'identifier': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- attachPoints (list) –
  
  The valid AttachPoint
  - (dict) –
    
    Describes a possible Attach Point for a Connection.
    - type (string) –
      
      The type of this AttachPoint, which will dictate the syntax of the identifier.
      
      Current types include:
      - ARN
      - DirectConnect Gateway
    - identifier (string) –
      
      The identifier for the specific type of the AttachPoint.
    - name (string) –
      
      The descriptive name of the identifier attach point.
- nextToken (string) –
  
  A pagination token indicating that there are more results that can be fetched.

Exceptions

Interconnect.Client.exceptions.ResourceNotFoundException
Interconnect.Client.exceptions.InterconnectClientException
Interconnect.Client.exceptions.ThrottlingException
Interconnect.Client.exceptions.AccessDeniedException
Interconnect.Client.exceptions.InterconnectValidationException
Interconnect.Client.exceptions.ServiceQuotaExceededException
Interconnect.Client.exceptions.InterconnectServerException