describe_buckets `async` ¶

describe_buckets(
    *,
    config_overrides: Optional[AsyncMacie2ClientConfig] = None,
    criteria: Optional[BucketCriteria] = None,
    max_results: Optional[__integer] = None,
    next_token: Optional[__string] = None,
    sort_criteria: Optional[BucketSortCriteria] = None,
) -> DescribeBucketsResponse

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

Parameters:

criteria (Optional[BucketCriteria], default: None ) –

The criteria to use to filter the query results.
max_results (Optional[__integer], default: None ) –

The maximum number of items to include in each page of the response. The default value is 50.
next_token (Optional[__string], default: None ) –

The nextToken string that specifies which page of results to return in a paginated response.
sort_criteria (Optional[BucketSortCriteria], default: None ) –

The criteria to use to sort the query results.

Raises:

AccessDeniedException –

Provides information about an error that occurred due to insufficient access to a specified resource.
ConflictException –

Provides information about an error that occurred due to a versioning conflict for a specified resource.
InternalServerException –

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.
ResourceNotFoundException –

Provides information about an error that occurred because a specified resource wasn't found.
ServiceQuotaExceededException –

Provides information about an error that occurred due to one or more service quotas for an account.
ThrottlingException –

Provides information about an error that occurred because too many requests were sent during a certain amount of time.
ValidationException –

Provides information about an error that occurred due to a syntax error in a request.
UnknownServiceError –

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

Source code in docs_src/capo_macie2/_services/async_macie2.py

async def describe_buckets(
    self,
    *,
    config_overrides: Optional[AsyncMacie2ClientConfig] = None,
    criteria: Optional["capo_macie2.types.bucket_criteria.BucketCriteria"] = None,
    max_results: Optional["capo_macie2.types.__integer.__integer"] = None,
    next_token: Optional["capo_macie2.types.__string.__string"] = None,
    sort_criteria: Optional[
        "capo_macie2.types.bucket_sort_criteria.BucketSortCriteria"
    ] = None,
) -> "capo_macie2.types.describe_buckets_response.DescribeBucketsResponse":
    """<p>Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.</p>

    Args:
        criteria: <p>The criteria to use to filter the query results.</p>
        max_results: <p>The maximum number of items to include in each page of the response. The default value is 50.</p>
        next_token: <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
        sort_criteria: <p>The criteria to use to sort the query results.</p>

    Raises:
        capo_macie2.errors.access_denied_exception.AccessDeniedException: <p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>
        capo_macie2.errors.conflict_exception.ConflictException: <p>Provides information about an error that occurred due to a versioning conflict for a specified resource.</p>
        capo_macie2.errors.internal_server_exception.InternalServerException: <p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>
        capo_macie2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Provides information about an error that occurred because a specified resource wasn't found.</p>
        capo_macie2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Provides information about an error that occurred due to one or more service quotas for an account.</p>
        capo_macie2.errors.throttling_exception.ThrottlingException: <p>Provides information about an error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_macie2.errors.validation_exception.ValidationException: <p>Provides information about an error that occurred due to a syntax error in a request.</p>
        capo_macie2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_macie2.types.describe_buckets_request.DescribeBucketsRequest]",
    ) -> AsyncOperationResponse[
        "capo_macie2.types.describe_buckets_response.DescribeBucketsResponse"
    ]:
        import capo_macie2._operations.macie2.describe_buckets

        (
            output,
            http_response,
        ) = await capo_macie2._operations.macie2.describe_buckets.async_describe_buckets(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBuckets")
    )
    input_: capo_macie2.types.describe_buckets_request.DescribeBucketsRequest = {}
    if criteria is not None:
        input_["criteria"] = criteria
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_criteria is not None:
        input_["sort_criteria"] = sort_criteria

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_buckets async ¶

describe_buckets `async` ¶