update_instance_metadata_options ¶

def update_instance_metadata_options(
    self,
    instance_name: "capo_lightsail.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    http_tokens: Optional["capo_lightsail.types.http_tokens.HttpTokens"] = None,
    http_endpoint: Optional[
        "capo_lightsail.types.http_endpoint.HttpEndpoint"
    ] = None,
    http_put_response_hop_limit: Optional[
        "capo_lightsail.types.integer.integer"
    ] = None,
    http_protocol_ipv6: Optional[
        "capo_lightsail.types.http_protocol_ipv6.HttpProtocolIpv6"
    ] = None,
) -> "capo_lightsail.types.update_instance_metadata_options_result.UpdateInstanceMetadataOptionsResult":
    """<p>Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the <code>GetInstance</code> or <code>GetInstances</code> API operation initially responds with a state of <code>pending</code>. After the parameter modifications are successfully applied, the state changes to <code>applied</code> in subsequent <code>GetInstance</code> or <code>GetInstances</code> API calls. For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-instance-metadata-service">Use IMDSv2 with an Amazon Lightsail instance</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>

    Args:
        instance_name: <p>The name of the instance for which to update metadata parameters.</p>
        http_tokens: <p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p> <p>If the state is <code>optional</code>, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.</p> <p>If the state is <code>required</code>, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.</p>
        http_endpoint: <p>Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.</p> <p>If you specify a value of <code>disabled</code>, you cannot access your instance metadata.</p>
        http_put_response_hop_limit: <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.</p>
        http_protocol_ipv6: <p>Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.</p> <note> <p>This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (<code>eu-north-1</code>).</p> </note>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.account_setup_in_progress_exception.AccountSetupInProgressException: <p>Lightsail throws this exception when an account is still in the setup in progress state.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.update_instance_metadata_options_request.UpdateInstanceMetadataOptionsRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.update_instance_metadata_options_result.UpdateInstanceMetadataOptionsResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.update_instance_metadata_options

        output, http_response = (
            capo_lightsail._operations.lightsail_20161128.update_instance_metadata_options.update_instance_metadata_options(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateInstanceMetadataOptions")
    )
    input_: capo_lightsail.types.update_instance_metadata_options_request.UpdateInstanceMetadataOptionsRequest = {
        "instance_name": instance_name
    }
    if http_tokens is not None:
        input_["http_tokens"] = http_tokens
    if http_endpoint is not None:
        input_["http_endpoint"] = http_endpoint
    if http_put_response_hop_limit is not None:
        input_["http_put_response_hop_limit"] = http_put_response_hop_limit
    if http_protocol_ipv6 is not None:
        input_["http_protocol_ipv6"] = http_protocol_ipv6

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