POST /#Action=ModifyInstanceMetadataOptions

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 Instance metadata and user data in the Amazon EC2 User Guide.

Servers

https://ec2.{region}.amazonaws.com
https://ec2.amazonaws.com
https://ec2.{region}.amazonaws.com.cn

Request headers

Name	Type	Required	Description
`X-Amz-Content-Sha256`	String	No
`X-Amz-Credential`	String	No
`Content-Type`	String	Yes	The media type of the request body. Default value: "text/xml"
`X-Amz-Date`	String	No
`X-Amz-Algorithm`	String	No
`X-Amz-SignedHeaders`	String	No
`X-Amz-Security-Token`	String	No
`X-Amz-Signature`	String	No

Query parameters

Name Type Required Description

Name	Type	Required	Description
`Version`	String	Yes	Possible values: `"2016-11-15"`
`Action`	String	Yes	Possible values: `"ModifyInstanceMetadataOptions"`

Version

String

Yes

Possible values:

"2016-11-15"

Action

String

Yes

Possible values:

"ModifyInstanceMetadataOptions"

Request body fields

Name	Type	Required	Description
`InstanceId`	String	Yes	The ID of the instance.
`HttpEndpoint`	String	No	Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained. If you specify a value of `disabled`, you cannot access your instance metadata. Possible values: `"disabled"` `"enabled"`
`InstanceMetadataTags`	String	No	Set to `enabled` to allow access to instance tags from the instance metadata. Set to `disabled` to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata. Default: `disabled` Possible values: `"disabled"` `"enabled"`
`HttpPutResponseHopLimit`	Integer	No	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. Possible values: Integers from 1 to 64
`HttpTokens`	String	No	IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to `optional` (in other words, set the use of IMDSv2 to `optional`) or `required` (in other words, set the use of IMDSv2 to `required`). `optional` - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned. `required` - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. Default: `optional` Possible values: `"optional"` `"required"`
`HttpProtocolIpv6`	String	No	Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint. Possible values: `"disabled"` `"enabled"`
`DryRun`	Boolean	No	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 `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.