MediaConnect / Paginator / ListSourceEndpoints

ListSourceEndpoints

class MediaConnect.Paginator.ListSourceEndpoints

paginator = client.get_paginator('list_source_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaConnect.Client.list_source_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'SourceTypes': [
                'STANDARD'|'ROUTER_OUTPUT',
            ],
            'NameContains': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The filters to apply to the list of source endpoints.

  • (dict) –

    A filter to apply when listing source endpoints. This is a union type, so exactly one of its members is set.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: RegionNames, SourceTypes, NameContains.

    • RegionNames (list) –

      Filters the results to source endpoints in the specified Amazon Web Services Regions.

      • (string) –

    • SourceTypes (list) –

      Filters the results to source endpoints of the specified types.

      • (string) –

    • NameContains (list) –

      Filters the results to source endpoints whose names contain the specified strings.

      • (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

{
    'SourceEndpoints': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'SourceType': 'STANDARD'|'ROUTER_OUTPUT',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LifecycleManagement': 'MANAGED'|'UNMANAGED',
            'MessageCount': 123,
            'ResourceShareOwnership': 'OWNED'|'CONSUMED',
            'ResourceShareState': 'SHARED'|'UNSHARED',
            'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
            'EncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'ConnectedDestinationCount': 123,
            'AssociatedResourceArn': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • SourceEndpoints (list) –

    The source endpoints that match the request.

    • (dict) –

      A summary of a source endpoint that the ListSourceEndpoints operation returns.

      • Name (string) –

        The name of the source endpoint.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the source endpoint.

      • Id (string) –

        The unique identifier of the source endpoint.

      • SourceType (string) –

        The type of the source endpoint. Valid values include the following:

        • STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.

        • ROUTER_OUTPUT – A source endpoint that represents a router output.

      • RegionName (string) –

        The name of the Amazon Web Services Region in which the source endpoint is located.

      • AvailabilityZone (string) –

        The Availability Zone in which the source endpoint is located.

      • AvailabilityZoneId (string) –

        The ID of the Availability Zone in which the source endpoint is located.

      • CreatedAt (datetime) –

        The date and time when the source endpoint was created.

      • UpdatedAt (datetime) –

        The date and time when the source endpoint was last updated.

      • LifecycleManagement (string) –

        The entity that manages the lifecycle of the source endpoint.

      • MessageCount (integer) –

        The number of status messages for the source endpoint.

      • ResourceShareOwnership (string) –

        Indicates whether this account owns the source endpoint or consumes it from another account through RAM.

      • ResourceShareState (string) –

        The sharing state of the source endpoint.

      • RegistrationState (string) –

        The registration state of the source endpoint. Valid values include the following:

        • REGISTERED – The source endpoint is registered and ready to use.

        • REGISTERING – MediaConnect is registering the source endpoint.

        • DEREGISTERING – MediaConnect is deregistering the source endpoint.

        • REGISTRATION_FAILED – MediaConnect couldn’t register the source endpoint.

      • ConnectionState (string) –

        The connection state of the source endpoint. Valid values include the following:

        • CONNECTED – The source endpoint is connected to a destination endpoint.

        • DISCONNECTED – The source endpoint isn’t connected to a destination endpoint.

        • CONNECTING – The source endpoint is connecting to a destination endpoint.

        • DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.

      • EncryptionType (string) –

        The type of encryption used for the source endpoint connection.

      • ConnectedDestinationCount (integer) –

        The number of destination endpoints that are connected to the source endpoint.

      • AssociatedResourceArn (string) –

        The Amazon Resource Name (ARN) of the resource that is associated with the source endpoint.