create_api_mapping `async` ¶

create_api_mapping(
    domain_name: __string,
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    api_id: Optional[Id] = None,
    api_mapping_key: Optional[SelectionKey] = None,
    stage: Optional[StringWithLengthBetween1And128] = None,
) -> CreateApiMappingResponse

Creates an API mapping.

Parameters:

api_id (Optional[Id], default: None ) –

The API identifier.
api_mapping_key (Optional[SelectionKey], default: None ) –

The API mapping key.
domain_name (__string) –

The domain name.
stage (Optional[StringWithLengthBetween1And128], default: None ) –

The API stage.

Raises:

BadRequestException –

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
NotFoundException –

The resource specified in the request was not found. See the message field for more information.
TooManyRequestsException –

A limit has been exceeded. See the accompanying error message for details.
UnknownServiceError –

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

Source code in docs_src/capo_apigatewayv2/_services/async_api_gateway_v2.py

async def create_api_mapping(
    self,
    domain_name: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    api_id: Optional["capo_apigatewayv2.types.id.Id"] = None,
    api_mapping_key: Optional[
        "capo_apigatewayv2.types.selection_key.SelectionKey"
    ] = None,
    stage: Optional[
        "capo_apigatewayv2.types.string_with_length_between1_and128.StringWithLengthBetween1And128"
    ] = None,
) -> "capo_apigatewayv2.types.create_api_mapping_response.CreateApiMappingResponse":
    """<p>Creates an API mapping.</p>

    Args:
        api_id: <p>The API identifier.</p>
        api_mapping_key: The API mapping key.
        domain_name: <p>The domain name.</p>
        stage: <p>The API stage.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_apigatewayv2.types.create_api_mapping_request.CreateApiMappingRequest]",
    ) -> AsyncOperationResponse[
        "capo_apigatewayv2.types.create_api_mapping_response.CreateApiMappingResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.create_api_mapping

        (
            output,
            http_response,
        ) = await capo_apigatewayv2._operations.api_gateway_v2.create_api_mapping.async_create_api_mapping(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateApiMapping")
    )
    input_: capo_apigatewayv2.types.create_api_mapping_request.CreateApiMappingRequest = {
        "domain_name": domain_name
    }
    if api_id is not None:
        input_["api_id"] = api_id
    if api_mapping_key is not None:
        input_["api_mapping_key"] = api_mapping_key
    if stage is not None:
        input_["stage"] = stage

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

create_api_mapping async ¶

create_api_mapping `async` ¶