Package imds provides the API client for interacting with the Amazon EC2 Instance Metadata Service.
All Client operation calls have a default timeout. If the operation is not completed before this timeout expires, the operation will be canceled. This timeout can be overridden through the following:
See the EC2 IMDS user guide for more information on using the API. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
ServiceID provides the unique name of this API client
This section is empty.
WithAPIOptions wraps the API middleware functions, as a functional option for the API Client Options. Use this helper to add additional functional options to the API client, or operation calls.
Client provides the API client for interacting with the Amazon EC2 Instance Metadata Service API.
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
NewFromConfig returns an initialized Client based the AWS SDK config, and functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
GetDynamicData uses the path provided to request information from the EC2 instance metadata service for dynamic data. The content will be returned as a string, or error if the request failed.
GetIAMInfo retrieves an identity document describing an instance. Error is returned if the request fails or is unable to parse the response.
GetInstanceIdentityDocument retrieves an identity document describing an instance. Error is returned if the request fails or is unable to parse the response.
GetMetadata uses the path provided to request information from the Amazon EC2 Instance Metadata Service. The content will be returned as a string, or error if the request failed.
GetRegion retrieves an identity document describing an instance. Error is returned if the request fails or is unable to parse the response.
GetUserData uses the path provided to request information from the EC2 instance metadata service for dynamic data. The content will be returned as a string, or error if the request failed.
ClientEnableState provides an enumeration if the client is enabled, disabled, or default behavior.
Enumeration values for ClientEnableState
EndpointModeState is an enum configuration variable describing the client endpoint mode. Not configurable directly, but used when using the NewFromConfig.
Enumeration values for EndpointModeState
type GetDynamicDataInput struct {
Path string
}
GetDynamicDataInput provides the input parameters for the GetDynamicData operation.
GetDynamicDataOutput provides the output parameters for the GetDynamicData operation.
type GetIAMInfoInput struct{}
GetIAMInfoInput provides the input parameters for GetIAMInfo operation.
GetIAMInfoOutput provides the output parameters for GetIAMInfo operation.
type GetInstanceIdentityDocumentInput struct{}
GetInstanceIdentityDocumentInput provides the input parameters for GetInstanceIdentityDocument operation.
GetInstanceIdentityDocumentOutput provides the output parameters for GetInstanceIdentityDocument operation.
type GetMetadataInput struct {
Path string
}
GetMetadataInput provides the input parameters for the GetMetadata operation.
GetMetadataOutput provides the output parameters for the GetMetadata operation.
type GetRegionInput struct{}
GetRegionInput provides the input parameters for GetRegion operation.
GetRegionOutput provides the output parameters for GetRegion operation.
type GetUserDataInput struct{}
GetUserDataInput provides the input parameters for the GetUserData operation.
GetUserDataOutput provides the output parameters for the GetUserData operation.
HTTPClient provides the interface for a client making HTTP requests with the API.
IAMInfo provides the shape for unmarshaling an IAM info from the metadata API.
type InstanceIdentityDocument struct {
DevpayProductCodes []string `json:"devpayProductCodes"`
MarketplaceProductCodes []string `json:"marketplaceProductCodes"`
AvailabilityZone string `json:"availabilityZone"`
PrivateIP string `json:"privateIp"`
Version string `json:"version"`
Region string `json:"region"`
InstanceID string `json:"instanceId"`
BillingProducts []string `json:"billingProducts"`
InstanceType string `json:"instanceType"`
AccountID string `json:"accountId"`
PendingTime time.Time `json:"pendingTime"`
ImageID string `json:"imageId"`
KernelID string `json:"kernelId"`
RamdiskID string `json:"ramdiskId"`
Architecture string `json:"architecture"`
}
InstanceIdentityDocument provides the shape for unmarshaling an instance identity document
Options provides the fields for configuring the API client's behavior.
Copy creates a copy of the API options.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4