Skip to content

EC2  >  Operations  >  create_carrier_gateway

create_carrier_gateway

Operation

create_carrier_gateway async

create_carrier_gateway(request: CreateCarrierGatewayInput | CreateCarrierGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateCarrierGatewayOutput
create_carrier_gateway(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCarrierGatewayInputDict]) -> CreateCarrierGatewayOutput

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateCarrierGatewayOutput

An instance of CreateCarrierGatewayOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateCarrierGatewayInput dataclass

Bases: _SerdeShape

Dataclass for CreateCarrierGatewayInput structure.

Attributes
client_token class-attribute instance-attribute
client_token: str | None = ...

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

This field is autopopulated if not provided.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to associate with the carrier gateway.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

The ID of the VPC to associate with the carrier gateway.

Dictionaries

CreateCarrierGatewayInputDict

Bases: TypedDict

Dictionary form of CreateCarrierGatewayInput.

Attributes
client_token instance-attribute
client_token: str | None

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

This field is autopopulated if not provided.

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to associate with the carrier gateway.

vpc_id instance-attribute
vpc_id: Required[str]

The ID of the VPC to associate with the carrier gateway.

Output

CreateCarrierGatewayOutput dataclass

Bases: _SerdeShape

Dataclass for CreateCarrierGatewayOutput structure.

Attributes

carrier_gateway class-attribute instance-attribute
carrier_gateway: CarrierGateway | None = ...

Information about the carrier gateway.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.