modify_instance_metadata_options ¶

def modify_instance_metadata_options(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    instance_id: Optional["capo_ec2.types.instance_id.InstanceId"] = None,
    http_tokens: Optional[
        "capo_ec2.types.http_tokens_state.HttpTokensState"
    ] = None,
    http_put_response_hop_limit: Optional["capo_ec2.types.integer.Integer"] = None,
    http_endpoint: Optional[
        "capo_ec2.types.instance_metadata_endpoint_state.InstanceMetadataEndpointState"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    http_protocol_ipv6: Optional[
        "capo_ec2.types.instance_metadata_protocol_state.InstanceMetadataProtocolState"
    ] = None,
    instance_metadata_tags: Optional[
        "capo_ec2.types.instance_metadata_tags_state.InstanceMetadataTagsState"
    ] = None,
) -> "capo_ec2.types.modify_instance_metadata_options_result.ModifyInstanceMetadataOptionsResult":
    """<p>Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance metadata and user data</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        instance_id: <p>The ID of the instance.</p>
        http_tokens: <p>Indicates whether IMDSv2 is required.</p> <ul> <li> <p> <code>optional</code> - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.</p> </li> <li> <p> <code>required</code> - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.</p> </li> </ul> <p>Default:</p> <ul> <li> <p>If the value of <code>ImdsSupport</code> for the Amazon Machine Image (AMI) for your instance is <code>v2.0</code> and the account level default is set to <code>no-preference</code>, the default is <code>required</code>.</p> </li> <li> <p>If the value of <code>ImdsSupport</code> for the Amazon Machine Image (AMI) for your instance is <code>v2.0</code>, but the account level default is set to <code>V1 or V2</code>, the default is <code>optional</code>.</p> </li> </ul> <p>The default value can also be affected by other combinations of parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence">Order of precedence for instance metadata options</a> in the <i>Amazon EC2 User Guide</i>.</p>
        http_put_response_hop_limit: <p>The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.</p> <p>Possible values: Integers from 1 to 64</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>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        http_protocol_ipv6: <p>Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.</p>
        instance_metadata_tags: <p>Set to <code>enabled</code> to allow access to instance tags from the instance metadata. Set to <code>disabled</code> to turn off access to instance tags from the instance metadata. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html">View tags for your EC2 instances using instance metadata</a>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_instance_metadata_options_request.ModifyInstanceMetadataOptionsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_instance_metadata_options_result.ModifyInstanceMetadataOptionsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_instance_metadata_options

        output, http_response = (
            capo_ec2._operations.amazon_ec2.modify_instance_metadata_options.modify_instance_metadata_options(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyInstanceMetadataOptions")
    )
    input_: capo_ec2.types.modify_instance_metadata_options_request.ModifyInstanceMetadataOptionsRequest = {}
    if instance_id is not None:
        input_["instance_id"] = instance_id
    if http_tokens is not None:
        input_["http_tokens"] = http_tokens
    if http_put_response_hop_limit is not None:
        input_["http_put_response_hop_limit"] = http_put_response_hop_limit
    if http_endpoint is not None:
        input_["http_endpoint"] = http_endpoint
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if http_protocol_ipv6 is not None:
        input_["http_protocol_ipv6"] = http_protocol_ipv6
    if instance_metadata_tags is not None:
        input_["instance_metadata_tags"] = instance_metadata_tags

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