:doc:`CloudWatchObservabilityAccessManager <../../oam>` / Paginator / ListLinks

*********
ListLinks
*********



.. py:class:: CloudWatchObservabilityAccessManager.Paginator.ListLinks

  ::

    
    paginator = client.get_paginator('list_links')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchObservabilityAccessManager.Client.list_links`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListLinks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

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

      
      ::

        {
            'Items': [
                {
                    'Arn': 'string',
                    'Id': 'string',
                    'Label': 'string',
                    'ResourceTypes': [
                        'string',
                    ],
                    'SinkArn': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Items** *(list) --* 

          An array of structures that contain the information about the returned links.

          
          

          - *(dict) --* 

            A structure that contains information about one of this source account's links to a monitoring account.

            
            

            - **Arn** *(string) --* 

              The ARN of the link.

              
            

            - **Id** *(string) --* 

              The random ID string that Amazon Web Services generated as part of the link ARN.

              
            

            - **Label** *(string) --* 

              The label that was assigned to this link at creation, with the variables resolved to their actual values.

              
            

            - **ResourceTypes** *(list) --* 

              The resource types supported by this link.

              
              

              - *(string) --* 
          
            

            - **SinkArn** *(string) --* 

              The ARN of the sink that this link is attached to.

              
        
      
    