activate_gateway async ¶

async def activate_gateway(
    self,
    activation_key: "capo_storage_gateway.types.activation_key.ActivationKey",
    gateway_name: "capo_storage_gateway.types.gateway_name.GatewayName",
    gateway_timezone: "capo_storage_gateway.types.gateway_timezone.GatewayTimezone",
    gateway_region: "capo_storage_gateway.types.region_id.RegionId",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    gateway_type: Optional[
        "capo_storage_gateway.types.gateway_type.GatewayType"
    ] = None,
    tape_drive_type: Optional[
        "capo_storage_gateway.types.tape_drive_type.TapeDriveType"
    ] = None,
    medium_changer_type: Optional[
        "capo_storage_gateway.types.medium_changer_type.MediumChangerType"
    ] = None,
    tags: Optional["capo_storage_gateway.types.tags.Tags"] = None,
) -> "capo_storage_gateway.types.activate_gateway_output.ActivateGatewayOutput":
    """<p>Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see <a>UpdateGatewayInformation</a>.</p> <note> <p>You must turn on the gateway VM before you can activate your gateway.</p> </note>

    Args:
        activation_key: <p>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter <code>activationKey</code>. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the <code>ActivateGateway</code> API call determine the actual configuration of your gateway.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html">Getting activation key</a> in the <i>Storage Gateway User Guide</i>.</p>
        gateway_name: <p>The name you configured for your gateway.</p>
        gateway_timezone: <p>A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.</p>
        gateway_region: <p>A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your <code>Host</code> header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see <a href="https://docs.aws.amazon.com/general/latest/gr/sg.html"> Storage Gateway endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>Valid Values: See <a href="https://docs.aws.amazon.com/general/latest/gr/sg.html"> Storage Gateway endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>. </p>
        gateway_type: <p>A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is <code>CACHED</code>.</p> <important> <p>Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p> </important> <p>Valid Values: <code>STORED</code> | <code>CACHED</code> | <code>VTL</code> | <code>FILE_S3</code> | <code>FILE_FSX_SMB</code> </p>
        tape_drive_type: <p>The value that indicates the type of tape drive to use for tape gateway. This field is optional.</p> <p>Valid Values: <code>IBM-ULT3580-TD5</code> </p>
        medium_changer_type: <p>The value that indicates the type of medium changer to use for tape gateway. This field is optional.</p> <p>Valid Values: <code>STK-L700</code> | <code>AWS-Gateway-VTL</code> | <code>IBM-03584L32-0402</code> </p>
        tags: <p>A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.</p> </note>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To activate the gateway
        Activates the gateway you previously deployed on your host.

        >>> await client.activate_gateway(activation_key='29AV1-3OFV9-VVIUB-NKT0I-LRO6V', gateway_name='My_Gateway', gateway_timezone='GMT-12:00', gateway_region='us-east-1', gateway_type='STORED', tape_drive_type='IBM-ULT3580-TD5', medium_changer_type='AWS-Gateway-VTL')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.activate_gateway_input.ActivateGatewayInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.activate_gateway_output.ActivateGatewayOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.activate_gateway

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.activate_gateway.async_activate_gateway(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ActivateGateway")
    )
    input_: capo_storage_gateway.types.activate_gateway_input.ActivateGatewayInput = {
        "activation_key": activation_key,
        "gateway_name": gateway_name,
        "gateway_timezone": gateway_timezone,
        "gateway_region": gateway_region,
    }
    if gateway_type is not None:
        input_["gateway_type"] = gateway_type
    if tape_drive_type is not None:
        input_["tape_drive_type"] = tape_drive_type
    if medium_changer_type is not None:
        input_["medium_changer_type"] = medium_changer_type
    if tags is not None:
        input_["tags"] = tags

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