RDS / Paginator / DescribeDBProxyTargets

DescribeDBProxyTargets

class RDS.Paginator.DescribeDBProxyTargets

paginator = client.get_paginator('describe_db_proxy_targets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RDS.Client.describe_db_proxy_targets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DBProxyName='string',
    TargetGroupName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DBProxyName (string) –

  [REQUIRED]

  The identifier of the DBProxyTarget to describe.

• TargetGroupName (string) – The identifier of the DBProxyTargetGroup to describe.

• Filters (list) –

  This parameter is not currently supported.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribeDBRecommendations

    • DescribeDBShardGroups

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

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

{
    'Targets': [
        {
            'TargetArn': 'string',
            'Endpoint': 'string',
            'TrackedClusterId': 'string',
            'RdsResourceId': 'string',
            'Port': 123,
            'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
            'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
            'TargetHealth': {
                'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
                'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
                'Description': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Targets (list) –

    An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

    • (dict) –

      Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

      This data type is used as a response element in the DescribeDBProxyTargets action.

      • TargetArn (string) –

        The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

      • Endpoint (string) –

        The writer endpoint for the RDS DB instance or Aurora DB cluster.

      • TrackedClusterId (string) –

        The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

      • RdsResourceId (string) –

        The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

      • Port (integer) –

        The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

      • Type (string) –

        Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

      • Role (string) –

        A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

      • TargetHealth (dict) –

        Information about the connection health of the RDS Proxy target.

        • State (string) –

          The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

          registering > unavailable > available > unavailable > available

        • Reason (string) –

          The reason for the current health State of the RDS Proxy target.

        • Description (string) –

          A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

  • NextToken (string) –

    A token to resume pagination.