Skip to content

get_instance_metadata_defaults

get_instance_metadata_defaults(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
) -> GetInstanceMetadataDefaultsResult

Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.

For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def get_instance_metadata_defaults(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.get_instance_metadata_defaults_result.GetInstanceMetadataDefaultsResult":
    """<p>Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.</p> <p>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>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_instance_metadata_defaults_request.GetInstanceMetadataDefaultsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_instance_metadata_defaults_result.GetInstanceMetadataDefaultsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_instance_metadata_defaults

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInstanceMetadataDefaults")
    )
    input_: capo_ec2.types.get_instance_metadata_defaults_request.GetInstanceMetadataDefaultsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run

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