EC2 / Client / modify_instance_metadata_defaults

modify_instance_metadata_defaults#

EC2.Client.modify_instance_metadata_defaults(**kwargs)#

Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.

Note

To remove a parameter’s account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_instance_metadata_defaults(
    HttpTokens='optional'|'required'|'no-preference',
    HttpPutResponseHopLimit=123,
    HttpEndpoint='disabled'|'enabled'|'no-preference',
    InstanceMetadataTags='disabled'|'enabled'|'no-preference',
    DryRun=True|False
)
Parameters:

  • HttpTokens (string) –

    Indicates whether IMDSv2 is required.

    • optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

    • required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

  • HttpPutResponseHopLimit (integer) –

    The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1.

    Possible values: Integers from 1 to 64, and -1 to indicate no preference

  • HttpEndpoint (string) – Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can’t be accessed.

  • InstanceMetadataTags (string) – Enables or disables access to an instance’s tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.

  • DryRun (boolean) – Checks whether you have the required permissions for the operation, 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.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) –

    • Return (boolean) –

      If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.