odb / Paginator / ListAutonomousVirtualMachines

ListAutonomousVirtualMachines

class odb.Paginator.ListAutonomousVirtualMachines

paginator = client.get_paginator('list_autonomous_virtual_machines')

paginate(**kwargs)

Creates an iterator that will paginate through responses from odb.Client.list_autonomous_virtual_machines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    cloudAutonomousVmClusterId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• cloudAutonomousVmClusterId (string) –

  [REQUIRED]

  The unique identifier of the Autonomous VM cluster whose virtual machines you’re listing.

• 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

{
    'autonomousVirtualMachines': [
        {
            'autonomousVirtualMachineId': 'string',
            'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
            'statusReason': 'string',
            'vmName': 'string',
            'dbServerId': 'string',
            'dbServerDisplayName': 'string',
            'cpuCoreCount': 123,
            'memorySizeInGBs': 123,
            'dbNodeStorageSizeInGBs': 123,
            'clientIpAddress': 'string',
            'cloudAutonomousVmClusterId': 'string',
            'ocid': 'string',
            'ociResourceAnchorName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • autonomousVirtualMachines (list) –

    The list of Autonomous VMs in the specified Autonomous VM cluster.

    • (dict) –

      A summary of an Autonomous Virtual Machine (VM) within an Autonomous VM cluster.

      • autonomousVirtualMachineId (string) –

        The unique identifier of the Autonomous VM.

      • status (string) –

        The current status of the Autonomous VM.

      • statusReason (string) –

        Additional information about the current status of the Autonomous VM, if applicable.

      • vmName (string) –

        The name of the Autonomous VM.

      • dbServerId (string) –

        The unique identifier of the database server hosting this Autonomous VM.

      • dbServerDisplayName (string) –

        The display name of the database server hosting this Autonomous VM.

      • cpuCoreCount (integer) –

        The number of CPU cores allocated to this Autonomous VM.

      • memorySizeInGBs (integer) –

        The amount of memory allocated to this Autonomous VM, in gigabytes (GB).

      • dbNodeStorageSizeInGBs (integer) –

        The amount of storage allocated to this Autonomous Virtual Machine, in gigabytes (GB).

      • clientIpAddress (string) –

        The IP address used by clients to connect to this Autonomous VM.

      • cloudAutonomousVmClusterId (string) –

        The unique identifier of the Autonomous VM cluster containing this Autonomous VM.

      • ocid (string) –

        The Oracle Cloud Identifier (OCID) of the Autonomous VM.

      • ociResourceAnchorName (string) –

        The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with this Autonomous VM.

  • NextToken (string) –

    A token to resume pagination.