Skip to content

list_outposts_with_s3 async

list_outposts_with_s3(
    *,
    config_overrides: Optional[AsyncS3OutpostsClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListOutpostsWithS3Result

Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    When you can get additional results from the ListOutpostsWithS3 call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional Outposts.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of Outposts to return. The limit is 100.

Raises:

Source code in docs_src/capo_s3outposts/_services/async_s3_outposts.py
async def list_outposts_with_s3(
    self,
    *,
    config_overrides: Optional[AsyncS3OutpostsClientConfig] = None,
    next_token: Optional["capo_s3outposts.types.next_token.NextToken"] = None,
    max_results: Optional["capo_s3outposts.types.max_results.MaxResults"] = None,
) -> "capo_s3outposts.types.list_outposts_with_s3_result.ListOutpostsWithS3Result":
    """<p>Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM). </p>

    Args:
        next_token: <p>When you can get additional results from the <code>ListOutpostsWithS3</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional Outposts.</p>
        max_results: <p>The maximum number of Outposts to return. The limit is 100.</p>

    Raises:
        capo_s3outposts.errors.access_denied_exception.AccessDeniedException: <p>Access was denied for this action.</p>
        capo_s3outposts.errors.internal_server_exception.InternalServerException: <p>There was an exception with the internal server.</p>
        capo_s3outposts.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_s3outposts.errors.validation_exception.ValidationException: <p>There was an exception validating this data.</p>
        capo_s3outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_s3outposts.types.list_outposts_with_s3_request.ListOutpostsWithS3Request]",
    ) -> AsyncOperationResponse[
        "capo_s3outposts.types.list_outposts_with_s3_result.ListOutpostsWithS3Result"
    ]:
        import capo_s3outposts._operations.s3_outposts.list_outposts_with_s3

        (
            output,
            http_response,
        ) = await capo_s3outposts._operations.s3_outposts.list_outposts_with_s3.async_list_outposts_with_s3(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListOutpostsWithS3")
    )
    input_: capo_s3outposts.types.list_outposts_with_s3_request.ListOutpostsWithS3Request = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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