Lightsail / Client / get_disks

get_disks#

Lightsail.Client.get_disks(**kwargs)#

Returns information about all block storage disks in your AWS account and region.

Request Syntax

response = client.get_disks(
    pageToken='string'
)

Parameters:

pageToken (string) –

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Return type:

dict

Returns:

Response Syntax

{
    'disks': [
        {
            'name': 'string',
            'arn': 'string',
            'supportCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'addOns': [
                {
                    'name': 'string',
                    'status': 'string',
                    'snapshotTimeOfDay': 'string',
                    'nextSnapshotTimeOfDay': 'string',
                    'threshold': 'string',
                    'duration': 'string'
                },
            ],
            'sizeInGb': 123,
            'isSystemDisk': True|False,
            'iops': 123,
            'path': 'string',
            'state': 'pending'|'error'|'available'|'in-use'|'unknown',
            'attachedTo': 'string',
            'isAttached': True|False,
            'attachmentState': 'string',
            'gbInUse': 123,
            'autoMountStatus': 'Failed'|'Pending'|'Mounted'|'NotMounted'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- disks (list) –
  
  An array of objects containing information about all block storage disks.
  - (dict) –
    
    Describes a block storage disk.
    - name (string) –
      
      The unique name of the disk.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the disk.
    - supportCode (string) –
      
      The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) –
      
      The date when the disk was created.
    - location (dict) –
      
      The AWS Region and Availability Zone where the disk is located.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) –
        
        The Amazon Web Services Region name.
    - resourceType (string) –
      
      The Lightsail resource type (e.g., Disk).
    - tags (list) –
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      - (dict) –
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
        
        key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) –
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - addOns (list) –
      
      An array of objects representing the add-ons enabled on the disk.
      - (dict) –
        
        Describes an add-on that is enabled for an Amazon Lightsail resource.
        
        name (string) –
        
        The name of the add-on.
        
        status (string) –
        
        The status of the add-on.
        
        snapshotTimeOfDay (string) –
        
        The daily time when an automatic snapshot is created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        nextSnapshotTimeOfDay (string) –
        
        The next daily time an automatic snapshot will be created.
        
        The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
        
        The snapshot is automatically created between the time shown and up to 45 minutes after.
        
        threshold (string) –
        
        The trigger threshold of the action.
        
        Warning
        This add-on only applies to Lightsail for Research resources.
        
        duration (string) –
        
        The amount of idle time in minutes after which your virtual computer will automatically stop.
        
        Warning
        This add-on only applies to Lightsail for Research resources.
    - sizeInGb (integer) –
      
      The size of the disk in GB.
    - isSystemDisk (boolean) –
      
      A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
    - iops (integer) –
      
      The input/output operations per second (IOPS) of the disk.
    - path (string) –
      
      The disk path.
    - state (string) –
      
      Describes the status of the disk.
    - attachedTo (string) –
      
      The resources to which the disk is attached.
    - isAttached (boolean) –
      
      A Boolean value indicating whether the disk is attached.
    - attachmentState (string) –
      
      (Deprecated) The attachment state of the disk.
      
      Note
      In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
    - gbInUse (integer) –
      
      (Deprecated) The number of GB in use by the disk.
      
      Note
      In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
    - autoMountStatus (string) –
      
      The status of automatically mounting a storage disk to a virtual computer.
      
      Warning
      This parameter only applies to Lightsail for Research resources.
- nextPageToken (string) –
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.AccountSetupInProgressException
Lightsail.Client.exceptions.UnauthenticatedException

get_disks#

Request Syntax

Response Syntax

Response Structure

Warning

Warning

Note

Note

Warning

Exceptions