Skip to content

create_outpost

create_outpost(
    name: OutpostName,
    site_id: SiteId,
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    description: Optional[OutpostDescription] = None,
    availability_zone: Optional[AvailabilityZone] = None,
    availability_zone_id: Optional[AvailabilityZoneId] = None,
    tags: Optional[TagMap] = None,
    supported_hardware_type: Optional[SupportedHardwareType] = None,
) -> CreateOutpostOutput

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

Parameters:

  • site_id (SiteId) –

    The ID or the Amazon Resource Name (ARN) of the site.

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

    The tags to apply to the Outpost.

  • supported_hardware_type (Optional[SupportedHardwareType], default: None ) –

    The type of hardware for this Outpost.

Raises:

Source code in docs_src/capo_outposts/_services/outposts.py
def create_outpost(
    self,
    name: "capo_outposts.types.outpost_name.OutpostName",
    site_id: "capo_outposts.types.site_id.SiteId",
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    description: Optional[
        "capo_outposts.types.outpost_description.OutpostDescription"
    ] = None,
    availability_zone: Optional[
        "capo_outposts.types.availability_zone.AvailabilityZone"
    ] = None,
    availability_zone_id: Optional[
        "capo_outposts.types.availability_zone_id.AvailabilityZoneId"
    ] = None,
    tags: Optional["capo_outposts.types.tag_map.TagMap"] = None,
    supported_hardware_type: Optional[
        "capo_outposts.types.supported_hardware_type.SupportedHardwareType"
    ] = None,
) -> "capo_outposts.types.create_outpost_output.CreateOutpostOutput":
    """<p>Creates an Outpost.</p> <p>You can specify either an Availability one or an AZ ID.</p>

    Args:
        site_id: <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
        tags: <p>The tags to apply to the Outpost.</p>
        supported_hardware_type: <p> The type of hardware for this Outpost. </p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.conflict_exception.ConflictException: <p>Updating or deleting this resource can cause an inconsistent state.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded a service quota.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_outposts.types.create_outpost_input.CreateOutpostInput]",
    ) -> OperationResponse[
        "capo_outposts.types.create_outpost_output.CreateOutpostOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.create_outpost

        output, http_response = (
            capo_outposts._operations.outposts_olaf_service.create_outpost.create_outpost(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateOutpost")
    )
    input_: capo_outposts.types.create_outpost_input.CreateOutpostInput = {
        "name": name,
        "site_id": site_id,
    }
    if description is not None:
        input_["description"] = description
    if availability_zone is not None:
        input_["availability_zone"] = availability_zone
    if availability_zone_id is not None:
        input_["availability_zone_id"] = availability_zone_id
    if tags is not None:
        input_["tags"] = tags
    if supported_hardware_type is not None:
        input_["supported_hardware_type"] = supported_hardware_type

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