SSM / Paginator / ListCloudConnectors

ListCloudConnectors

class SSM.Paginator.ListCloudConnectors

paginator = client.get_paginator('list_cloud_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.list_cloud_connectors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'FilterKey': 'SubscriptionId'|'TenantId',
            'FilterValues': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  One or more filters to limit the cloud connectors returned in the response.

  • (dict) –

    A filter for listing cloud connectors.

    • FilterKey (string) –

      The name of the filter key.

    • FilterValues (list) –

      The filter values. Valid values for each filter key are as follows:

      SubscriptionId

      The Azure subscription ID to filter by. To return only tenant-level connectors, specify NONE.

      TenantId

      The Azure tenant ID to filter by. Filters the results to connectors that target the specified tenant.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CloudConnectors': [
        {
            'CloudConnectorId': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'RoleArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • CloudConnectors (list) –

    A list of cloud connector summary objects.

    • (dict) –

      Summary information about a cloud connector.

      • CloudConnectorId (string) –

        The ID of the cloud connector.

      • DisplayName (string) –

        The friendly name of the cloud connector.

      • Description (string) –

        The description of the cloud connector.

      • RoleArn (string) –

        The ARN of the IAM role used by the cloud connector.

      • CreatedAt (datetime) –

        The date and time the cloud connector was created.

      • UpdatedAt (datetime) –

        The date and time the cloud connector was last updated.