DataZone / Client / list_subscription_targets

list_subscription_targets#

DataZone.Client.list_subscription_targets(**kwargs)#

Lists subscription targets in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.list_subscription_targets(
    domainIdentifier='string',
    environmentIdentifier='string',
    maxResults=123,
    nextToken='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain where you want to list subscription targets.

  • environmentIdentifier (string) –

    [REQUIRED]

    The identifier of the environment where you want to list subscription targets.

  • maxResults (integer) – The maximum number of subscription targets to return in a single call to ListSubscriptionTargets. When the number of subscription targets to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

  • nextToken (string) – When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

  • sortBy (string) – Specifies the way in which the results of this action are to be sorted.

  • sortOrder (string) – Specifies the sort order for the results of this action.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'applicableAssetTypes': [
                'string',
            ],
            'authorizedPrincipals': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'domainId': 'string',
            'environmentId': 'string',
            'id': 'string',
            'manageAccessRole': 'string',
            'name': 'string',
            'projectId': 'string',
            'provider': 'string',
            'subscriptionTargetConfig': [
                {
                    'content': 'string',
                    'formName': 'string'
                },
            ],
            'type': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListSubscriptionTargets action.

      • (dict) –

        The details of the subscription target.

        • applicableAssetTypes (list) –

          The asset types included in the subscription target.

          • (string) –

        • authorizedPrincipals (list) –

          The authorized principals included in the subscription target.

          • (string) –

        • createdAt (datetime) –

          The timestamp of when the subscription target was created.

        • createdBy (string) –

          The Amazon DataZone user who created the subscription target.

        • domainId (string) –

          The identifier of the Amazon DataZone domain in which the subscription target exists.

        • environmentId (string) –

          The identifier of the environment of the subscription target.

        • id (string) –

          The identifier of the subscription target.

        • manageAccessRole (string) –

          The manage access role specified in the subscription target.

        • name (string) –

          The name of the subscription target.

        • projectId (string) –

          The identifier of the project specified in the subscription target.

        • provider (string) –

          The provider of the subscription target.

        • subscriptionTargetConfig (list) –

          The configuration of the subscription target.

          • (dict) –

            The details of the subscription target configuration.

            • content (string) –

              The content of the subscription target configuration.

            • formName (string) –

              The form name included in the subscription target configuration.

        • type (string) –

          The type of the subscription target.

        • updatedAt (datetime) –

          The timestamp of when the subscription target was updated.

        • updatedBy (string) –

          The Amazon DataZone user who updated the subscription target.

    • nextToken (string) –

      When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

Exceptions