AmazonMachineImageFulfillmentOption
Describes an Amazon Machine Image (AMI) fulfillment option, including version details, supported operating systems, and recommended instance types.
Contents
Note
In the following list, the required parameters are described first.
- architecture
-
The architecture of the AMI, such as
x86_64.Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
- fulfillmentOptionDisplayName
-
A human-readable name for the fulfillment option type.
Type: String
Required: Yes
- fulfillmentOptionId
-
The unique identifier of the fulfillment option.
Type: String
Required: Yes
- fulfillmentOptionName
-
The display name of the fulfillment option version.
Type: String
Required: Yes
- fulfillmentOptionType
-
The category of the fulfillment option.
Type: String
Valid Values:
AMAZON_MACHINE_IMAGE | API | CLOUDFORMATION_TEMPLATE | CONTAINER | HELM | EKS_ADD_ON | EC2_IMAGE_BUILDER_COMPONENT | DATA_EXCHANGE | PROFESSIONAL_SERVICES | SAAS | SAGEMAKER_ALGORITHM | SAGEMAKER_MODELRequired: Yes
- operatingSystems
-
The operating systems supported by this AMI.
Type: Array of AmazonMachineImageOperatingSystem objects
Required: Yes
- accessUrlTemplate
-
The URL pattern for accessing the product when an instance is running.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- amiAlias
-
The alias of the AMI associated with this fulfillment option.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- availableFromTime
-
The date and time when the AMI became available for fulfillment.
Type: Timestamp
Required: No
- ebsVolume
-
The supported Amazon EBS volume configuration for the AMI.
Type: AmazonMachineImageEbsVolume object
Required: No
- fulfillmentOptionVersion
-
The version identifier of the fulfillment option.
Type: String
Required: No
- recommendation
-
Recommended instance types for running this AMI.
Type: AmazonMachineImageRecommendation object
Required: No
- releaseNotes
-
Release notes describing changes in this version of the fulfillment option.
Type: String
Required: No
- shortDescription
-
A short description of the fulfillment option.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- usageInstructions
-
Instructions on how to deploy and use this fulfillment option.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
