get_regions ¶

def get_regions(
    self,
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    include_availability_zones: Optional[
        "capo_lightsail.types.boolean.boolean"
    ] = None,
    include_relational_database_availability_zones: Optional[
        "capo_lightsail.types.boolean.boolean"
    ] = None,
) -> "capo_lightsail.types.get_regions_result.GetRegionsResult":
    """<p>Returns a list of all valid regions for Amazon Lightsail. Use the <code>include availability zones</code> parameter to also return the Availability Zones in a region.</p>

    Args:
        include_availability_zones: <p>A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: <code>us-east-2a</code>.</p>
        include_relational_database_availability_zones: <p>A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (<code>us-east-2a</code>).</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.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.get_regions_request.GetRegionsRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.get_regions_result.GetRegionsResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_regions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRegions")
    )
    input_: capo_lightsail.types.get_regions_request.GetRegionsRequest = {}
    if include_availability_zones is not None:
        input_["include_availability_zones"] = include_availability_zones
    if include_relational_database_availability_zones is not None:
        input_["include_relational_database_availability_zones"] = (
            include_relational_database_availability_zones
        )

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