get_bucket_bundles ¶

get_bucket_bundles(
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    include_inactive: Optional[boolean] = None,
) -> GetBucketBundlesResult

Returns the bundles that you can apply to a Amazon Lightsail bucket.

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to update the bundle for a bucket.

Parameters:

include_inactive (Optional[boolean], default: None ) –

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/lightsail.py

def get_bucket_bundles(
    self,
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    include_inactive: Optional["capo_lightsail.types.boolean.boolean"] = None,
) -> "capo_lightsail.types.get_bucket_bundles_result.GetBucketBundlesResult":
    """<p>Returns the bundles that you can apply to a Amazon Lightsail bucket.</p> <p>The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html">UpdateBucketBundle</a> action to update the bundle for a bucket.</p>

    Args:
        include_inactive: <p>A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.get_bucket_bundles_request.GetBucketBundlesRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.get_bucket_bundles_result.GetBucketBundlesResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_bucket_bundles

        output, http_response = (
            capo_lightsail._operations.lightsail_20161128.get_bucket_bundles.get_bucket_bundles(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBucketBundles")
    )
    input_: capo_lightsail.types.get_bucket_bundles_request.GetBucketBundlesRequest = {}
    if include_inactive is not None:
        input_["include_inactive"] = include_inactive

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output