RDS / Client / describe_db_proxies

describe_db_proxies#

RDS.Client.describe_db_proxies(**kwargs)#

Returns information about DB proxies.

Request Syntax

response = client.describe_db_proxies(
    DBProxyName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

DBProxyName (string) – The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
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) –
Marker (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords (integer) –
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Return type:

dict

Returns:

Response Syntax

{
    'DBProxies': [
        {
            'DBProxyName': 'string',
            'DBProxyArn': 'string',
            'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
            'EngineFamily': 'string',
            'VpcId': 'string',
            'VpcSecurityGroupIds': [
                'string',
            ],
            'VpcSubnetIds': [
                'string',
            ],
            'Auth': [
                {
                    'Description': 'string',
                    'UserName': 'string',
                    'AuthScheme': 'SECRETS',
                    'SecretArn': 'string',
                    'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED',
                    'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION'
                },
            ],
            'RoleArn': 'string',
            'Endpoint': 'string',
            'RequireTLS': True|False,
            'IdleClientTimeout': 123,
            'DebugLogging': True|False,
            'CreatedDate': datetime(2015, 1, 1),
            'UpdatedDate': datetime(2015, 1, 1)
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) –
- DBProxies (list) –
  
  A return value representing an arbitrary number of DBProxy data structures.
  - (dict) –
    
    The data structure representing a proxy managed by the RDS Proxy.
    
    This data type is used as a response element in the DescribeDBProxies action.
    - DBProxyName (string) –
      
      The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
    - DBProxyArn (string) –
      
      The Amazon Resource Name (ARN) for the proxy.
    - Status (string) –
      
      The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
    - EngineFamily (string) –
      
      The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.
    - VpcId (string) –
      
      Provides the VPC ID of the DB proxy.
    - VpcSecurityGroupIds (list) –
      
      Provides a list of VPC security groups that the proxy belongs to.
      - (string) –
    - VpcSubnetIds (list) –
      
      The EC2 subnet IDs for the proxy.
      - (string) –
    - Auth (list) –
      
      One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
      - (dict) –
        
        Returns the details of authentication used by a proxy to log in as a specific database user.
        
        Description (string) –
        
        A user-specified description about the authentication used by a proxy to log in as a specific database user.
        
        UserName (string) –
        
        The name of the database user to which the proxy connects.
        
        AuthScheme (string) –
        
        The type of authentication that the proxy uses for connections from the proxy to the underlying database.
        
        SecretArn (string) –
        
        The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
        
        IAMAuth (string) –
        
        Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
        
        ClientPasswordAuthType (string) –
        
        The type of authentication the proxy uses for connections from clients.
    - RoleArn (string) –
      
      The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
    - Endpoint (string) –
      
      The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
    - RequireTLS (boolean) –
      
      Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
    - IdleClientTimeout (integer) –
      
      The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
      
      Default: 1800 (30 minutes)
      
      Constraints: 1 to 28,800
    - DebugLogging (boolean) –
      
      Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
    - CreatedDate (datetime) –
      
      The date and time when the proxy was first created.
    - UpdatedDate (datetime) –
      
      The date and time when the proxy was last updated.
- Marker (string) –
  
  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Exceptions

RDS.Client.exceptions.DBProxyNotFoundFault