get_distributions `async` ¶

get_distributions(
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    distribution_name: Optional[ResourceName] = None,
    page_token: Optional[string] = None,
) -> GetDistributionsResult

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

Parameters:

distribution_name (Optional[ResourceName], default: None ) –

The name of the distribution for which to return information.

When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.
page_token (Optional[string], default: None ) –

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
OperationFailureException –

Lightsail throws this exception when an operation fails to execute.
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/async_lightsail.py

async def get_distributions(
    self,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    distribution_name: Optional[
        "capo_lightsail.types.resource_name.ResourceName"
    ] = None,
    page_token: Optional["capo_lightsail.types.string.string"] = None,
) -> "capo_lightsail.types.get_distributions_result.GetDistributionsResult":
    """<p>Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.</p>

    Args:
        distribution_name: <p>The name of the distribution for which to return information.</p> <p>When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.</p>
        page_token: <p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetDistributions</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent 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.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.get_distributions_request.GetDistributionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.get_distributions_result.GetDistributionsResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_distributions

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.get_distributions.async_get_distributions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDistributions")
    )
    input_: capo_lightsail.types.get_distributions_request.GetDistributionsRequest = {}
    if distribution_name is not None:
        input_["distribution_name"] = distribution_name
    if page_token is not None:
        input_["page_token"] = page_token

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

get_distributions async ¶

get_distributions `async` ¶