:doc:`DataZone <../../datazone>` / Client / list_subscription_targets

*************************
list_subscription_targets
*************************



.. py:method:: DataZone.Client.list_subscription_targets(**kwargs)

  

  Lists subscription targets in Amazon DataZone.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListSubscriptionTargets>`_  


  **Request Syntax**
  ::

    response = client.list_subscription_targets(
        domainIdentifier='string',
        environmentIdentifier='string',
        sortBy='CREATED_AT'|'UPDATED_AT',
        sortOrder='ASCENDING'|'DESCENDING',
        maxResults=123,
        nextToken='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

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

    

  
  :type environmentIdentifier: string
  :param environmentIdentifier: **[REQUIRED]** 

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

    

  
  :type sortBy: string
  :param sortBy: 

    Specifies the way in which the results of this action are to be sorted.

    

  
  :type sortOrder: string
  :param sortOrder: 

    Specifies the sort order for the results of this action.

    

  
  :type maxResults: integer
  :param maxResults: 

    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.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        The results of the ``ListSubscriptionTargets`` action.

        
        

        - *(dict) --* 

          The details of the subscription target.

          
          

          - **id** *(string) --* 

            The identifier of the subscription target.

            
          

          - **authorizedPrincipals** *(list) --* 

            The authorized principals included in the subscription target.

            
            

            - *(string) --* 
        
          

          - **domainId** *(string) --* 

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

            
          

          - **projectId** *(string) --* 

            The identifier of the project specified in the subscription target.

            
          

          - **environmentId** *(string) --* 

            The identifier of the environment of the subscription target.

            
          

          - **name** *(string) --* 

            The name of the subscription target.

            
          

          - **type** *(string) --* 

            The type of the subscription target.

            
          

          - **createdBy** *(string) --* 

            The Amazon DataZone user who created the subscription target.

            
          

          - **updatedBy** *(string) --* 

            The Amazon DataZone user who updated the subscription target.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp of when the subscription target was created.

            
          

          - **updatedAt** *(datetime) --* 

            The timestamp of when the subscription target was updated.

            
          

          - **manageAccessRole** *(string) --* 

            The manage access role specified in the subscription target.

            
          

          - **applicableAssetTypes** *(list) --* 

            The asset types included in the subscription target.

            
            

            - *(string) --* 
        
          

          - **subscriptionTargetConfig** *(list) --* 

            The configuration of the subscription target.

            
            

            - *(dict) --* 

              The details of the subscription target configuration.

              
              

              - **formName** *(string) --* 

                The form name included in the subscription target configuration.

                
              

              - **content** *(string) --* 

                The content of the subscription target configuration.

                
          
        
          

          - **provider** *(string) --* 

            The provider of the subscription target.

            
          

          - **subscriptionGrantCreationMode** *(string) --* 

            Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

            
      
    
      

      - **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**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  