Skip to content

create_requester_gateway

create_requester_gateway(
    vpc_id: VpcId,
    subnet_ids: SubnetIdList,
    security_group_ids: SecurityGroupIdList,
    client_token: str,
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
    description: Optional[str] = None,
    tags: Optional[TagsMap] = None,
) -> CreateRequesterGatewayResponse

Creates a requester gateway.

Parameters:

  • vpc_id (VpcId) –

    The unique identifier of the Virtual Private Cloud (VPC).

  • subnet_ids (SubnetIdList) –

    The unique identifiers of the subnets.

  • security_group_ids (SecurityGroupIdList) –

    The unique identifiers of the security groups.

  • client_token (str) –

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

  • description (Optional[str], default: None ) –

    An optional description for the requester gateway.

  • tags (Optional[TagsMap], default: None ) –

    A map of the key-value pairs of the tag or tags to assign to the resource.

Raises:

Examples:

Create a requester gateway Create requester gateway

>>> client.create_requester_gateway(description='My requester gateway', vpc_id='vpc-12345678', subnet_ids=['subnet-12345678', 'subnet-87654321'], security_group_ids=['sg-12345678'], client_token='12345678-1234-1234-1234-123456789012')
Source code in docs_src/capo_rtbfabric/_services/rtb_fabric.py
def create_requester_gateway(
    self,
    vpc_id: "capo_rtbfabric.types.vpc_id.VpcId",
    subnet_ids: "capo_rtbfabric.types.subnet_id_list.SubnetIdList",
    security_group_ids: "capo_rtbfabric.types.security_group_id_list.SecurityGroupIdList",
    client_token: str,
    *,
    config_overrides: Optional[RTBFabricClientConfig] = None,
    description: Optional[str] = None,
    tags: Optional["capo_rtbfabric.types.tags_map.TagsMap"] = None,
) -> "capo_rtbfabric.types.create_requester_gateway_response.CreateRequesterGatewayResponse":
    """<p>Creates a requester gateway.</p>

    Args:
        vpc_id: <p>The unique identifier of the Virtual Private Cloud (VPC).</p>
        subnet_ids: <p>The unique identifiers of the subnets.</p>
        security_group_ids: <p>The unique identifiers of the security groups.</p>
        client_token: <p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>clientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>
        description: <p>An optional description for the requester gateway.</p>
        tags: <p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>

    Raises:
        capo_rtbfabric.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
        capo_rtbfabric.errors.internal_server_exception.InternalServerException: <p>The request could not be completed because of an internal server error. Try your call again.</p>
        capo_rtbfabric.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request could not be completed because the resource does not exist.</p>
        capo_rtbfabric.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request could not be completed because you exceeded a service quota.</p>
        capo_rtbfabric.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_rtbfabric.errors.validation_exception.ValidationException: <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
        capo_rtbfabric.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create a requester gateway
        Create requester gateway

        >>> client.create_requester_gateway(description='My requester gateway', vpc_id='vpc-12345678', subnet_ids=['subnet-12345678', 'subnet-87654321'], security_group_ids=['sg-12345678'], client_token='12345678-1234-1234-1234-123456789012')
    """

    def _handler(
        req: "OperationRequest[capo_rtbfabric.types.create_requester_gateway_request.CreateRequesterGatewayRequest]",
    ) -> OperationResponse[
        "capo_rtbfabric.types.create_requester_gateway_response.CreateRequesterGatewayResponse"
    ]:
        import capo_rtbfabric._operations.rtb_fabric.create_requester_gateway

        output, http_response = (
            capo_rtbfabric._operations.rtb_fabric.create_requester_gateway.create_requester_gateway(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRequesterGateway")
    )
    input_: capo_rtbfabric.types.create_requester_gateway_request.CreateRequesterGatewayRequest = {
        "vpc_id": vpc_id,
        "subnet_ids": subnet_ids,
        "security_group_ids": security_group_ids,
        "client_token": client_token,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

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