DBInstanceAvailable

class Neptune.Waiter.DBInstanceAvailable

waiter = client.get_waiter('db_instance_available')

wait(**kwargs)

Polls Neptune.Client.describe_db_instances() 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',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• DBInstanceIdentifier (string) --

  The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

  Constraints:

  • If supplied, must match the identifier of an existing DBInstance.
• Filters (list) --

  A filter that specifies one or more DB instances to describe.

  Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.
  • engine - Accepts an engine name (such as neptune ), and restricts the results list to DB instances created by that engine.

  For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

  • (dict) --

    This type is not currently supported.

    • Name (string) -- [REQUIRED]

      This parameter is not currently supported.

    • Values (list) -- [REQUIRED]

      This parameter is not currently supported.

      • (string) --
• 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.

• Marker (string) -- An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
• 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