2020/07/01 - EC2 Image Builder - 4 updated api methods
Changes Update imagebuilder client to latest version
{'distributions': {'amiDistributionConfiguration': {'kmsKeyId': 'string'}}}
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
See also: AWS API Documentation
Request Syntax
client.create_distribution_configuration(
name='string',
description='string',
distributions=[
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'licenseConfigurationArns': [
'string',
]
},
],
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the distribution configuration.
string
The description of the distribution configuration.
list
[REQUIRED]
The distributions of the distribution configuration.
(dict) --
Defines the settings for a specific Region.
region (string) -- [REQUIRED]
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings (for example, launch permissions, AMI tags).
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
dict
The tags of the distribution configuration.
(string) --
(string) --
string
[REQUIRED]
The idempotency token of the distribution configuration.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'distributionConfigurationArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The idempotency token used to make this request idempotent.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
{'distributionConfiguration': {'distributions': {'amiDistributionConfiguration': {'kmsKeyId': 'string'}}}}
Gets a distribution configuration.
See also: AWS API Documentation
Request Syntax
client.get_distribution_configuration(
distributionConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'distributionConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'distributions': [
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'licenseConfigurationArns': [
'string',
]
},
],
'timeoutMinutes': 123,
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
distributionConfiguration (dict) --
The distribution configuration object.
arn (string) --
The Amazon Resource Name (ARN) of the distribution configuration.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
distributions (list) --
The distributions of the distribution configuration.
(dict) --
Defines the settings for a specific Region.
region (string) --
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings (for example, launch permissions, AMI tags).
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
timeoutMinutes (integer) --
The maximum duration in minutes for this distribution configuration.
dateCreated (string) --
The date on which this distribution configuration was created.
dateUpdated (string) --
The date on which this distribution configuration was last updated.
tags (dict) --
The tags of the distribution configuration.
(string) --
(string) --
{'image': {'distributionConfiguration': {'distributions': {'amiDistributionConfiguration': {'kmsKeyId': 'string'}}}}}
Gets an image.
See also: AWS API Documentation
Request Syntax
client.get_image(
imageBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image that you want to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'image': {
'arn': 'string',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'enhancedImageMetadataEnabled': True|False,
'osVersion': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'imageRecipe': {
'arn': 'string',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'version': 'string',
'components': [
{
'componentArn': 'string'
},
],
'parentImage': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
},
'virtualName': 'string',
'noDevice': 'string'
},
],
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'workingDirectory': 'string'
},
'sourcePipelineName': 'string',
'sourcePipelineArn': 'string',
'infrastructureConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'instanceTypes': [
'string',
],
'instanceProfileName': 'string',
'securityGroupIds': [
'string',
],
'subnetId': 'string',
'logging': {
's3Logs': {
's3BucketName': 'string',
's3KeyPrefix': 'string'
}
},
'keyPair': 'string',
'terminateInstanceOnFailure': True|False,
'snsTopicArn': 'string',
'dateCreated': 'string',
'dateUpdated': 'string',
'resourceTags': {
'string': 'string'
},
'tags': {
'string': 'string'
}
},
'distributionConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'distributions': [
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'licenseConfigurationArns': [
'string',
]
},
],
'timeoutMinutes': 123,
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
},
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'dateCreated': 'string',
'outputResources': {
'amis': [
{
'region': 'string',
'image': 'string',
'name': 'string',
'description': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
}
},
]
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
image (dict) --
The image object.
arn (string) --
The Amazon Resource Name (ARN) of the image.
name (string) --
The name of the image.
version (string) --
The semantic version of the image.
platform (string) --
The platform of the image.
enhancedImageMetadataEnabled (boolean) --
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
osVersion (string) --
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
state (dict) --
The state of the image.
status (string) --
The status of the image.
reason (string) --
The reason for the image's status.
imageRecipe (dict) --
The image recipe used when creating the image.
arn (string) --
The Amazon Resource Name (ARN) of the image recipe.
name (string) --
The name of the image recipe.
description (string) --
The description of the image recipe.
platform (string) --
The platform of the image recipe.
owner (string) --
The owner of the image recipe.
version (string) --
The version of the image recipe.
components (list) --
The components of the image recipe.
(dict) --
Configuration details of the component.
componentArn (string) --
The Amazon Resource Name (ARN) of the component.
parentImage (string) --
The parent image of the image recipe.
blockDeviceMappings (list) --
The block device mappings to apply when creating images from this recipe.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the parent image.
dateCreated (string) --
The date on which this image recipe was created.
tags (dict) --
The tags of the image recipe.
(string) --
(string) --
workingDirectory (string) --
The working directory to be used during build and test workflows.
sourcePipelineName (string) --
The name of the image pipeline that created this image.
sourcePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that created this image.
infrastructureConfiguration (dict) --
The infrastructure used when creating this image.
arn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration.
name (string) --
The name of the infrastructure configuration.
description (string) --
The description of the infrastructure configuration.
instanceTypes (list) --
The instance types of the infrastructure configuration.
(string) --
instanceProfileName (string) --
The instance profile of the infrastructure configuration.
securityGroupIds (list) --
The security group IDs of the infrastructure configuration.
(string) --
subnetId (string) --
The subnet ID of the infrastructure configuration.
logging (dict) --
The logging configuration of the infrastructure configuration.
s3Logs (dict) --
The Amazon S3 logging configuration.
s3BucketName (string) --
The Amazon S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The Amazon S3 path in which to store the logs.
keyPair (string) --
The EC2 key pair of the infrastructure configuration.
terminateInstanceOnFailure (boolean) --
The terminate instance on failure configuration of the infrastructure configuration.
snsTopicArn (string) --
The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.
dateCreated (string) --
The date on which the infrastructure configuration was created.
dateUpdated (string) --
The date on which the infrastructure configuration was last updated.
resourceTags (dict) --
The tags attached to the resource created by Image Builder.
(string) --
(string) --
tags (dict) --
The tags of the infrastructure configuration.
(string) --
(string) --
distributionConfiguration (dict) --
The distribution configuration used when creating this image.
arn (string) --
The Amazon Resource Name (ARN) of the distribution configuration.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
distributions (list) --
The distributions of the distribution configuration.
(dict) --
Defines the settings for a specific Region.
region (string) --
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings (for example, launch permissions, AMI tags).
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
timeoutMinutes (integer) --
The maximum duration in minutes for this distribution configuration.
dateCreated (string) --
The date on which this distribution configuration was created.
dateUpdated (string) --
The date on which this distribution configuration was last updated.
tags (dict) --
The tags of the distribution configuration.
(string) --
(string) --
imageTestsConfiguration (dict) --
The image tests configuration used when creating this image.
imageTestsEnabled (boolean) --
Defines if tests should be executed when building this image.
timeoutMinutes (integer) --
The maximum time in minutes that tests are permitted to run.
dateCreated (string) --
The date on which this image was created.
outputResources (dict) --
The output resources produced when creating this image.
amis (list) --
The EC2 AMIs created by this image.
(dict) --
Details of an EC2 AMI.
region (string) --
The AWS Region of the EC2 AMI.
image (string) --
The AMI ID of the EC2 AMI.
name (string) --
The name of the EC2 AMI.
description (string) --
The description of the EC2 AMI.
state (dict) --
Image state shows the image status and the reason for that status.
status (string) --
The status of the image.
reason (string) --
The reason for the image's status.
tags (dict) --
The tags of the image.
(string) --
(string) --
{'distributions': {'amiDistributionConfiguration': {'kmsKeyId': 'string'}}}
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
See also: AWS API Documentation
Request Syntax
client.update_distribution_configuration(
distributionConfigurationArn='string',
description='string',
distributions=[
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'licenseConfigurationArns': [
'string',
]
},
],
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
string
The description of the distribution configuration.
list
[REQUIRED]
The distributions of the distribution configuration.
(dict) --
Defines the settings for a specific Region.
region (string) -- [REQUIRED]
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings (for example, launch permissions, AMI tags).
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
string
[REQUIRED]
The idempotency token of the distribution configuration.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'distributionConfigurationArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The idempotency token used to make this request idempotent.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.