CloudWatchOmni / Paginator / ListIntegrations

ListIntegrations

class CloudWatchOmni.Paginator.ListIntegrations

paginator = client.get_paginator('list_integrations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.list_integrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    integrationType='AWS_CONFIG_SLREC'|'SLACK'|'EXTERNAL_AGENT'|'AWS_INTEGRATION',
    status='ACTIVE'|'DELETED'|'PENDING'|'PENDING_OAUTH'|'ERROR'|'FAILED',
    name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• integrationType (string) – Returns only integrations of this provider type.

• status (string) – Returns only integrations in this status.

• name (string) – Returns only the integration with this exact name.

• 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

{
    'items': [
        {
            'integrationId': 'string',
            'integrationArn': 'string',
            'integrationType': 'AWS_CONFIG_SLREC'|'SLACK'|'EXTERNAL_AGENT'|'AWS_INTEGRATION',
            'name': 'string',
            'status': 'ACTIVE'|'DELETED'|'PENDING'|'PENDING_OAUTH'|'ERROR'|'FAILED',
            'authType': 'NONE'|'OAUTH2'|'API_KEY',
            'credentialArn': 'string',
            'roleArn': 'string',
            'integrationAttributes': {
                'string': 'string'
            },
            'authorizationUrl': 'string',
            'errorMessage': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'scope': 'ACCOUNT'|'ORGANIZATION'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response containing a page of integrations.

  • items (list) –

    The page of integrations.

    • (dict) –

      A connection between CloudWatch and an external system — such as a source of telemetry or configuration data, a messaging destination, or a model provider.

      • integrationId (string) –

        The unique identifier of the integration.

      • integrationArn (string) –

        The Amazon Resource Name (ARN) of the integration.

      • integrationType (string) –

        The type of external system that an integration connects to, such as a source of configuration data, a messaging destination, or a model provider.

      • name (string) –

        The customer-provided name of the integration.

      • status (string) –

        The current lifecycle state of an integration.

      • authType (string) –

        The authentication method that an integration uses to connect to its external system.

      • credentialArn (string) –

        The Amazon Resource Name (ARN) of the secret that stores the integration’s credentials.

      • roleArn (string) –

        The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

      • integrationAttributes (dict) –

        Provider-specific key/value attributes that configure the integration.

        • (string) –

          • (string) –

      • authorizationUrl (string) –

        The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.

      • errorMessage (string) –

        A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.

      • createdAt (datetime) –

        The time at which the integration was created.

      • updatedAt (datetime) –

        The time at which the integration was last updated.

      • scope (string) –

        Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.

  • NextToken (string) –

    A token to resume pagination.