Module netapp_ontap.resources.s3_bucket_snapshot

Copyright © 2024 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

Overview

An S3 bucket snapshot is an image of the bucket as it exists at the time when the snapshot is created.
S3 bucket snapshots can be created using scheduled snapshot policies set on the bucket, or user requested snapshot creations.
S3 bucket snapshot APIs allow you to create, delete, and retrieve snapshots.

Snapshot APIs

The following APIs are used to perform operations related to snapshots.

  • POST /api/protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/snapshots
  • GET /api/protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/snapshots
  • GET /api/protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/snapshots/{uuid}
  • DELETE /api/protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/snapshots/{uuid}

Examples

Creating an S3 bucket snapshot

The POST operation is used to create an S3 bucket snapshot with the specified name.

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3BucketSnapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3BucketSnapshot("{svm.uuid}", "{s3_bucket.uuid}")
    resource.name = "ss1"
    resource.post(hydrate=True)
    print(resource)

S3BucketSnapshot({"name": "ss1"})

Retrieving S3 bucket snapshots

The GET operation is used to retrieve all S3 bucket snapshots for a specific bucket.

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3BucketSnapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(S3BucketSnapshot.get_collection("{svm.uuid}", "{s3_bucket.uuid}")))

[
    S3BucketSnapshot({"name": "ss1", "uuid": "20837456-3c8b-405a-aa3a-5300c048f87d"}),
    S3BucketSnapshot({"name": "ss2", "uuid": "c67cd056-d386-477a-8378-fcc06987bedf"}),
]

Retrieving S3 bucket snapshots and all snapshot attributes

The GET operation is used to retrieve all S3 bucket snapshots for a specific bucket along with all the snapshot attributes.

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3BucketSnapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            S3BucketSnapshot.get_collection(
                "{svm.uuid}", "{s3_bucket.uuid}", fields="**"
            )
        )
    )

[
    S3BucketSnapshot(
        {
            "create_time": "2024-08-22T14:23:54-04:00",
            "name": "ss1",
            "uuid": "20837456-3c8b-405a-aa3a-5300c048f87d",
            "svm": {"uuid": "148b9bbd-58d8-11ef-b7ca-005056ae1130"},
        }
    ),
    S3BucketSnapshot(
        {
            "create_time": "2024-08-22T14:30:42-04:00",
            "name": "ss2",
            "uuid": "c67cd056-d386-477a-8378-fcc06987bedf",
            "svm": {"uuid": "148b9bbd-58d8-11ef-b7ca-005056ae1130"},
        }
    ),
]

Retrieving the attributes of a specific S3 bucket snapshot

The GET operation is used to retrieve the attributes of a specific S3 bucket snapshot.

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3BucketSnapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3BucketSnapshot("{svm.uuid}", "{s3_bucket.uuid}", uuid="{uuid}")
    resource.get()
    print(resource)

S3BucketSnapshot(
    {
        "create_time": "2024-08-22T14:30:42-04:00",
        "name": "ss2",
        "uuid": "c67cd056-d386-477a-8378-fcc06987bedf",
        "svm": {"uuid": "148b9bbd-58d8-11ef-b7ca-005056ae1130"},
    }
)

Deleting an S3 bucket snapshot

The DELETE operation is used to delete an S3 bucket snapshot.

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3BucketSnapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3BucketSnapshot("{svm.uuid}", "{s3_bucket.uuid}", uuid="{uuid}")
    resource.delete()

Classes

class S3BucketSnapshot (*args, **kwargs)

Information about an S3 bucket snapshot.

Initialize the instance of the resource.

Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

MyResource(name='foo').name == 'foo'

Args

*args
Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

Ancestors

Static methods

def count_collection (*args, connection: HostConnection = None, **kwargs) -> int

Returns a count of all S3BucketSnapshot resources that match the provided query


This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

Returns

On success, returns an integer count of the objects of this type. On failure, returns -1.

Raises

NetAppRestError: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

def delete_collection (*args, records: Iterable[ForwardRef('S3BucketSnapshot')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes S3 bucket snapshot.

  • vserver object-store-server bucket snapshot delete

Learn more


Delete all objects in a collection which match the given query.

All records on the host which match the query will be deleted.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
records
Can be provided in place of a query. If so, this list of objects will be deleted from the host.
body
The body of the delete request. This could be a Resource instance or a dictionary object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]

Returns a list of RawResources that represent S3BucketSnapshot resources that match the provided query


Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result
of this call is iterated over. For instance, if max_records is set to 5,
then iterating over the collection causes an API call to be sent to the
server once for every 5 records. If the client stops iterating before
getting to the 6th record, then no additional API calls are made.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records
The maximum number of records to return per call
raw
return a list of netapp_ontap.resource.RawResource objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def find (*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves a collection of S3 bucket snapshots.

  • vserver object-store-server bucket snapshot show

Learn more


Find an instance of an object on the host given a query.

The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A Resource object containing the details of the object or None if no matches were found.

Raises

NetAppRestError: If the API call returned more than 1 matching resource.

def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]

Retrieves a collection of S3 bucket snapshots.

  • vserver object-store-server bucket snapshot show

Learn more


Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result
of this call is iterated over. For instance, if max_records is set to 5,
then iterating over the collection causes an API call to be sent to the
server once for every 5 records. If the client stops iterating before
getting to the 6th record, then no additional API calls are made.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records
The maximum number of records to return per call
raw
return a list of netapp_ontap.resource.RawResource objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def post_collection (records: Iterable[ForwardRef('S3BucketSnapshot')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> Union[List[S3BucketSnapshot], NetAppResponse]

Creates an S3 bucket snapshot.

Required properties

  • name - Name of the S3 bucket snapshot to be created.
  • vserver object-store-server bucket snapshot create

Learn more


Send this collection of objects to the host as a creation request.

Args

records
A list of Resource objects to send to the server to be created.
*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to create a bar for a particular foo, the foo.name value should be passed.
hydrate
If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A list of Resource objects matching the provided type which have been created by the host and returned. This is not the same list that was provided, so to continue using the object, you should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

NetAppRestError: If the API call returned a status code >= 400

Methods

def delete (self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Deletes S3 bucket snapshot.

  • vserver object-store-server bucket snapshot delete

Learn more


Send a deletion request to the host for this object.

Args

body
The body of the delete request. This could be a Resource instance or a dictionary object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def get (self, **kwargs) -> NetAppResponse

Retrieves details of a specific S3 bucket snapshot.

  • vserver object-store-server bucket snapshot show

Learn more


Fetch the details of the object from the host.

Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400 or if not all of the keys required are present and config.STRICT_GET has been set to True.

def post (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Creates an S3 bucket snapshot.

Required properties

  • name - Name of the S3 bucket snapshot to be created.
  • vserver object-store-server bucket snapshot create

Learn more


Send this object to the host as a creation request.

Args

hydrate
If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

class S3BucketSnapshotSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

The fields of the S3BucketSnapshot object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC
  • abc.ABC

Class variables

bucket_uuid: str GET

The unique identifier of the bucket.

Example: 2aec8270-58e3-11ef-861e-005056ae1130

create_time: ImpreciseDateTime GET

Creation time of the snapshot. It is the storage unit access time when the snapshot was created.

Example: 2024-08-22T00:18:04.000+0000

The links field of the s3_bucket_snapshot.

name: str GET POST

The name of the snapshot. Snapshot names must start with a lowercase letter, a number, or a hyphen, must end with a lowercase letter or a number, and cannot exceed 30 characters.

Example: snap1

svm: Svm GET

The svm field of the s3_bucket_snapshot.

uuid: str GET

The UUID of the snapshot in the bucket that uniquely identifies the snapshot in that bucket.

Example: 522b29a1-3b26-11e9-bd58-0050568ea321