RDS / Waiter / TenantDatabaseDeleted

TenantDatabaseDeleted#

class RDS.Waiter.TenantDatabaseDeleted#
waiter = client.get_waiter('tenant_database_deleted')
wait(**kwargs)#

Polls RDS.Client.describe_tenant_databases() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBInstanceIdentifier='string',
    TenantDBName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • DBInstanceIdentifier (string) – The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn’t case-sensitive.

  • TenantDBName (string) – The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

  • Filters (list) –

    A filter that specifies one or more database tenants to describe.

    Supported filters:

    • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

    • tenant-database-resource-id - Tenant database resource identifiers.

    • dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

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

      • 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 DescribeTenantDatabases 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 you can retrieve the remaining results.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 60

Returns:

None