get_key_pairs `async` ¶

get_key_pairs(
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    page_token: Optional[string] = None,
    include_default_key_pair: Optional[boolean] = None,
) -> GetKeyPairsResult

Returns information about all key pairs in the user's account.

Parameters:

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 GetKeyPairs 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.
include_default_key_pair (Optional[boolean], default: None ) –

A Boolean value that indicates whether to include the default key pair 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.
AccountSetupInProgressException –

Lightsail throws this exception when an account is still in the setup in progress state.
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.
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/async_lightsail.py

async def get_key_pairs(
    self,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    page_token: Optional["capo_lightsail.types.string.string"] = None,
    include_default_key_pair: Optional[
        "capo_lightsail.types.boolean.boolean"
    ] = None,
) -> "capo_lightsail.types.get_key_pairs_result.GetKeyPairsResult":
    """<p>Returns information about all key pairs in the user's account.</p>

    Args:
        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>GetKeyPairs</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>
        include_default_key_pair: <p>A Boolean value that indicates whether to include the default key pair 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.account_setup_in_progress_exception.AccountSetupInProgressException: <p>Lightsail throws this exception when an account is still in the setup in progress state.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.get_key_pairs_request.GetKeyPairsRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.get_key_pairs_result.GetKeyPairsResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_key_pairs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKeyPairs")
    )
    input_: capo_lightsail.types.get_key_pairs_request.GetKeyPairsRequest = {}
    if page_token is not None:
        input_["page_token"] = page_token
    if include_default_key_pair is not None:
        input_["include_default_key_pair"] = include_default_key_pair

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

get_key_pairs async ¶

get_key_pairs `async` ¶