# Module `netapp_ontap.resources.s3_bucket_lifecycle_rule`

Copyright © 2023 NetApp Inc. All rights reserved.

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

## Overview

An S3 bucket lifecycle management rule is a list of objects. Each rule defines a set of actions to be performed on the object within the bucket.

### Adding a lifecycle management rule on a S3 bucket under an SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import S3BucketLifecycleRule

    with HostConnection("<mgmt-ip>", username="admin", password="netapp1!", verify=False):
        resource = S3BucketLifecycleRule(
            "259b4e78-2893-67ea-9785-890456bbbec4", "259b4e46-2893-67ea-9145-909456bbbec4"
        )
        resource.name = "rule1"
        resource.expiration = {"object_age_days": "1000"}
        resource.abort_incomplete_multipart_upload = {"after_initiation_days": 200}
        resource.object_filter = {"prefix": "obj1*/", "size_greater_than": "1000"}
        resource.post(hydrate=True, return_timeout=0)
        print(resource)

Try it out

    S3BucketLifecycleRule(
        {
            "object_filter": {"size_greater_than": 1000, "prefix": "obj1*/"},
            "name": "rule1",
            "expiration": {"object_age_days": 1000},
            "abort_incomplete_multipart_upload": {"after_initiation_days": 200},
        }
    )

### Updating a lifecycle management rule on a S3 bucket under an SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import S3BucketLifecycleRule

    with HostConnection("<mgmt-ip>", username="admin", password="netapp1!", verify=False):
        resource = S3BucketLifecycleRule(
            "259b4e78-2893-67ea-9785-890456bbbec4",
            "259b4e46-2893-67ea-9145-909456bbbec4",
            name="rule1",
        )
        resource.expiration = {"object_age_days": "3000"}
        resource.abort_incomplete_multipart_upload = {"after_initiation_days": "5000"}
        resource.patch(hydrate=True, return_timeout=0)

### Deleting a lifecycle management rule on a S3 bucket under an SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import S3BucketLifecycleRule

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = S3BucketLifecycleRule(
            "259b4e78-2893-67ea-9785-890456bbbec4",
            "259b4e46-2893-67ea-9145-909456bbbec4",
            name="rule1",
        )
        resource.delete()

### To delete an action within a rule, pass null inside the action-object.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import S3BucketLifecycleRule

    with HostConnection("<mgmt-ip>", username="admin", password="netapp1!", verify=False):
        resource = S3BucketLifecycleRule(
            "259b4e78-2893-67ea-9785-890456bbbec4",
            "259b4e46-2893-67ea-9145-909456bbbec4",
            name="rule1",
        )
        resource.expiration = None
        resource.patch(hydrate=True, return_timeout=0)

## Classes

`class S3BucketLifecycleRule (*args, **kwargs)`

  Information about the lifecycle management rule of a bucket.

  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

  - Resource

  ### Static methods

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

    Returns a count of all S3BucketLifecycleRule 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('S3BucketLifecycleRule')] = 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 the S3 bucket lifecycle rule configuration.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule delete`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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 S3BucketLifecycleRule 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 all S3 Lifecycle rules associated with a bucket. Note that in order to retrieve S3 bucket rule parametes, the 'fields' option should be set to '**'.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule show`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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 all S3 Lifecycle rules associated with a bucket. Note that in order to retrieve S3 bucket rule parametes, the 'fields' option should be set to '**'.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule show`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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 patch_collection (body: dict, *args, records: Iterable[_ForwardRef('S3BucketLifecycleRule')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Updates the S3 bucket lifecycle rule configuration.

    ### Important notes

    - The following fields can be modified for a bucket:
    - `actions` - Lifecycle Management actions associated with the rule.
    - `enabled` - Lifecycle Management rule is enabled or not..
    - `object_age_days` - Number of days since creation after which objects can be deleted.
    - `object_expiry_date` - Specific date from when objects can expire.
    - `expired_object_delete_marker` - Cleanup object delete markers.
    - `new_non_current_versions` - Number of latest non-current versions to be retained.
    - `non_current_days` - Number of days after which non-current versions can be deleted.
    - `after_initiation_days` - Number of days of initiation after which uploads can be aborted.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule modify`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

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

    All records on the host which match the query will be patched with the provided body.

    ## Args

    `body`
      A dictionary of name/value pairs to set on all matching members of the collection. The body argument will be ignored if records is provided.
    `*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 patch 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 patched on the host.
    `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 `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

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

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

    Creates the S3 bucket lifecycle rule configuration.

    ### Required properties

    - `name` - Lifecycle Management rule to be created.
    - `actions` - Lifecycle Management actions associated with the rule.

    ### Recommended optional properties

    - `enabled` - Lifecycle Management rule is enabled or not.
    - `object_filter.prefix` - Lifecycle Management rule filter prefix.
    - `object_filter.tags` - Lifecycle Management rule filter tags.
    - `object_filter.size_greater_than` - Lifecycle Management rule filter minimum object size.
    - `object_filter.size_less_than` - Lifecycle Management rule filter maximum object size.
    - `object_age_days` - Number of days since creation after which objects can be deleted.
    - `object_expiry_date` - Specific date from when objects can expire.
    - `expired_object_delete_marker` - Cleanup object delete markers.
    - `new_non_current_versions` - Number of latest non-current versions to be retained.
    - `non_current_days` - Number of days after which non-current versions can be deleted.
    - `after_initiation_days` - Number of days of initiation after which uploads can be aborted.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule create`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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 the S3 bucket lifecycle rule configuration.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule delete`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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 all S3 Lifecycle rules associated with a bucket. Note that in order to retrieve S3 bucket rule parametes, the 'fields' option should be set to '**'.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule show`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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

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

    Updates the S3 bucket lifecycle rule configuration.

    ### Important notes

    - The following fields can be modified for a bucket:
    - `actions` - Lifecycle Management actions associated with the rule.
    - `enabled` - Lifecycle Management rule is enabled or not..
    - `object_age_days` - Number of days since creation after which objects can be deleted.
    - `object_expiry_date` - Specific date from when objects can expire.
    - `expired_object_delete_marker` - Cleanup object delete markers.
    - `new_non_current_versions` - Number of latest non-current versions to be retained.
    - `non_current_days` - Number of days after which non-current versions can be deleted.
    - `after_initiation_days` - Number of days of initiation after which uploads can be aborted.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule modify`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    Send the difference in the object's state to the host as a modification request.

    Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

    ## 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

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

    Creates the S3 bucket lifecycle rule configuration.

    ### Required properties

    - `name` - Lifecycle Management rule to be created.
    - `actions` - Lifecycle Management actions associated with the rule.

    ### Recommended optional properties

    - `enabled` - Lifecycle Management rule is enabled or not.
    - `object_filter.prefix` - Lifecycle Management rule filter prefix.
    - `object_filter.tags` - Lifecycle Management rule filter tags.
    - `object_filter.size_greater_than` - Lifecycle Management rule filter minimum object size.
    - `object_filter.size_less_than` - Lifecycle Management rule filter maximum object size.
    - `object_age_days` - Number of days since creation after which objects can be deleted.
    - `object_expiry_date` - Specific date from when objects can expire.
    - `expired_object_delete_marker` - Cleanup object delete markers.
    - `new_non_current_versions` - Number of latest non-current versions to be retained.
    - `non_current_days` - Number of days after which non-current versions can be deleted.
    - `after_initiation_days` - Number of days of initiation after which uploads can be aborted.

    ### Related ONTAP commands

    - `vserver object-store-server bucket lifecycle-management-rule create`

    ### Learn more

    - `DOC /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules`

    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

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class S3BucketLifecycleRuleSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the S3BucketLifecycleRule object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `abort_incomplete_multipart_upload: S3BucketLifecycleAbortIncompleteMultipartUpload GET POST PATCH`

    The abort_incomplete_multipart_upload field of the s3_bucket_lifecycle_rule.

  `bucket_name: str GET POST`

    Specifies the name of the bucket. Bucket name is a string that can only contain the following combination of ASCII-range alphanumeric characters 0-9, a-z, ".", and "-".

    Example: bucket1

  `enabled: bool GET POST PATCH`

    Specifies whether or not the associated rule is enabled.

  `expiration: S3BucketLifecycleExpiration GET POST PATCH`

    The expiration field of the s3_bucket_lifecycle_rule.

  `links: SelfLink GET`

    The links field of the s3_bucket_lifecycle_rule.

  `name: str GET POST`

    Bucket lifecycle management rule identifier. The length of the name can range from 0 to 256 characters.

  `non_current_version_expiration: S3BucketLifecycleNonCurrentVersionExpiration GET POST PATCH`

    The non_current_version_expiration field of the s3_bucket_lifecycle_rule.

  `object_filter: S3BucketLifecycleObjectFilter GET POST`

    The object_filter field of the s3_bucket_lifecycle_rule.

  `svm: Svm GET POST PATCH`

    The svm field of the s3_bucket_lifecycle_rule.

  `uuid: str GET`

    Specifies the unique identifier of the bucket.

    Example: 414b29a1-3b26-11e9-bd58-0050568ea055