2019/12/02 - EC2 Image Builder - 42 new api methods
Changes This is the first release of EC2 Image Builder, a service that provides a managed experience for automating the creation of EC2 AMIs.
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'
},
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'licenseConfigurationArns': [
'string',
]
},
],
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration that you wish to update.
string
The description of the distribution configuration.
list
The distributions of the distribution configuration.
(dict) --
region (string) -- [REQUIRED]
amiDistributionConfiguration (dict) --
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) --
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
(string) --
userGroups (list) --
(string) --
licenseConfigurationArns (list) --
(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.
Gets an image pipeline.
See also: AWS API Documentation
Request Syntax
client.get_image_pipeline(
imagePipelineArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image pipeline that you wish to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'imagePipeline': {
'arn': 'string',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'imageRecipeArn': 'string',
'infrastructureConfigurationArn': 'string',
'distributionConfigurationArn': 'string',
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'schedule': {
'scheduleExpression': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE'
},
'status': 'DISABLED'|'ENABLED',
'dateCreated': 'string',
'dateUpdated': 'string',
'dateLastRun': 'string',
'dateNextRun': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imagePipeline (dict) --
The image pipeline object.
arn (string) --
The Amazon Resource Name (ARN) of the image pipeline.
name (string) --
The name of the image pipeline.
description (string) --
The description of the image pipeline.
platform (string) --
The platform of the image pipeline.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastruction configuration associated with this image pipeline.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
imageTestsConfiguration (dict) --
The image tests configuration of the image pipeline.
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 for.
schedule (dict) --
The schedule of the image pipeline.
scheduleExpression (string) --
The expression determines how often a pipeline starts the creation of new images.
pipelineExecutionStartCondition (string) --
The condition configures when the pipeline should trigger a new image build.
status (string) --
The status of the image pipeline.
dateCreated (string) --
The date on which this image pipeline was created.
dateUpdated (string) --
The date on which this image pipeline was last updated.
dateLastRun (string) --
The date on which this image pipeline was last run.
dateNextRun (string) --
The date on which this image pipeline will next be run.
tags (dict) --
The tags of this image pipeline.
(string) --
(string) --
Gets an image recipe policy.
See also: AWS API Documentation
Request Syntax
client.get_image_recipe_policy(
imageRecipeArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe whose policy you wish to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'policy': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
policy (string) --
The image recipe policy object.
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 wish to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'image': {
'arn': 'string',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'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'
}
},
'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',
'tags': {
'string': 'string'
}
},
'distributionConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'distributions': [
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'amiTags': {
'string': '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.
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 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) --
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 infrastruction configuration.
name (string) --
The name of the infrastruction configuration.
description (string) --
The description of the infrastruction configuration.
instanceTypes (list) --
The instance types of the infrastruction configuration.
(string) --
instanceProfileName (string) --
The instance profile of the infrastruction configuration.
securityGroupIds (list) --
The security group IDs of the infrastruction configuration.
(string) --
subnetId (string) --
The subnet ID of the infrastruction configuration.
logging (dict) --
The logging configuration of the infrastruction configuration.
s3Logs (dict) --
The S3 logging configuration.
s3BucketName (string) --
The S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The S3 path in which to store the logs.
keyPair (string) --
The EC2 key pair of the infrastruction configuration.
terminateInstanceOnFailure (boolean) --
The terminate instance on failure configuration of the infrastruction configuration.
snsTopicArn (string) --
The SNS Topic Amazon Resource Name (ARN) of the infrastruction configuration.
dateCreated (string) --
The date on which the infrastructure configuration was created.
dateUpdated (string) --
The date on which the infrastructure configuration was last updated.
tags (dict) --
The tags of the infrastruction 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) --
region (string) --
amiDistributionConfiguration (dict) --
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) --
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
(string) --
userGroups (list) --
(string) --
licenseConfigurationArns (list) --
(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 for.
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 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 images 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) --
Returns a list of image pipelines.
See also: AWS API Documentation
Request Syntax
client.list_image_pipelines(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'imagePipelineList': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'imageRecipeArn': 'string',
'infrastructureConfigurationArn': 'string',
'distributionConfigurationArn': 'string',
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'schedule': {
'scheduleExpression': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE'
},
'status': 'DISABLED'|'ENABLED',
'dateCreated': 'string',
'dateUpdated': 'string',
'dateLastRun': 'string',
'dateNextRun': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imagePipelineList (list) --
The list of image pipelines.
(dict) --
Details of an image pipeline.
arn (string) --
The Amazon Resource Name (ARN) of the image pipeline.
name (string) --
The name of the image pipeline.
description (string) --
The description of the image pipeline.
platform (string) --
The platform of the image pipeline.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastruction configuration associated with this image pipeline.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
imageTestsConfiguration (dict) --
The image tests configuration of the image pipeline.
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 for.
schedule (dict) --
The schedule of the image pipeline.
scheduleExpression (string) --
The expression determines how often a pipeline starts the creation of new images.
pipelineExecutionStartCondition (string) --
The condition configures when the pipeline should trigger a new image build.
status (string) --
The status of the image pipeline.
dateCreated (string) --
The date on which this image pipeline was created.
dateUpdated (string) --
The date on which this image pipeline was last updated.
dateLastRun (string) --
The date on which this image pipeline was last run.
dateNextRun (string) --
The date on which this image pipeline will next be run.
tags (dict) --
The tags of this image pipeline.
(string) --
(string) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
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 wish 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'
},
'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) --
region (string) --
amiDistributionConfiguration (dict) --
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) --
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
(string) --
userGroups (list) --
(string) --
licenseConfigurationArns (list) --
(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) --
Deletes an image recipe.
See also: AWS API Documentation
Request Syntax
client.delete_image_recipe(
imageRecipeArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe to delete.
dict
Response Syntax
{
'requestId': 'string',
'imageRecipeArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe that was deleted.
Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
See also: AWS API Documentation
Request Syntax
client.update_image_pipeline(
imagePipelineArn='string',
description='string',
imageRecipeArn='string',
infrastructureConfigurationArn='string',
distributionConfigurationArn='string',
imageTestsConfiguration={
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
schedule={
'scheduleExpression': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE'
},
status='DISABLED'|'ENABLED',
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image pipeline that you wish to update.
string
The description of the image pipeline.
string
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
string
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
string
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
dict
The image test configuration of the image pipeline.
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 for.
dict
The schedule of the image pipeline.
scheduleExpression (string) --
The expression determines how often a pipeline starts the creation of new images.
pipelineExecutionStartCondition (string) --
The condition configures when the pipeline should trigger a new image build.
string
The status of the image pipeline.
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imagePipelineArn': '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.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
Returns the list of component build versions for the specified semantic version.
See also: AWS API Documentation
Request Syntax
client.list_component_build_versions(
componentVersionArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The component version arn whose versions you wish to list.
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'componentSummaryList': [
{
'arn': 'string',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'type': 'BUILD'|'TEST',
'owner': 'string',
'description': 'string',
'changeDescription': 'string',
'dateCreated': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
componentSummaryList (list) --
The list of component summaries for the specified semantic version.
(dict) --
A high level summary of a component.
arn (string) --
The Amazon Resource Name (ARN) of the component.
name (string) --
The name of the component.
version (string) --
The version of the component.
platform (string) --
The platform of the component.
type (string) --
The type of the component denotes whether the component is used to build the image or only to test it.
owner (string) --
The owner of the component.
description (string) --
The description of the component.
changeDescription (string) --
The change description of the component.
dateCreated (string) --
The date that the component was created.
tags (dict) --
The tags associated with the component.
(string) --
(string) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Deletes a component build version.
See also: AWS API Documentation
Request Syntax
client.delete_component(
componentBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the component build version to delete.
dict
Response Syntax
{
'requestId': 'string',
'componentBuildVersionArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
componentBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the component build version that was deleted.
Applies a policy to an image.
See also: AWS API Documentation
Request Syntax
client.put_image_policy(
imageArn='string',
policy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image that this policy should be applied to.
string
[REQUIRED]
The policy to apply.
dict
Response Syntax
{
'requestId': 'string',
'imageArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageArn (string) --
The Amazon Resource Name (ARN) of the image that this policy was applied to.
Returns a list of distribution configurations.
See also: AWS API Documentation
Request Syntax
client.list_distribution_configurations(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'distributionConfigurationSummaryList': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
distributionConfigurationSummaryList (list) --
The list of distributions.
(dict) --
A high level overview a distribution configuration.
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.
dateCreated (string) --
The date on which the distribution configuration was created.
dateUpdated (string) --
The date on which the distribution configuration was updated.
tags (dict) --
The tags associated with the distribution configuration.
(string) --
(string) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you wish to untag.
list
[REQUIRED]
The tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets an image recipe.
See also: AWS API Documentation
Request Syntax
client.get_image_recipe(
imageRecipeArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe that you wish to retrieve.
dict
Response Syntax
{
'requestId': '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'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageRecipe (dict) --
The image recipe object.
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 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) --
Creates a new image recipe. Image Recipes defines how images are configured, tested and assessed.
See also: AWS API Documentation
Request Syntax
client.create_image_recipe(
name='string',
description='string',
semanticVersion='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'
},
],
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the image recipe.
string
The description of the image recipe.
string
[REQUIRED]
The semantic version of the image recipe.
list
[REQUIRED]
The components of the image recipe.
(dict) --
Configuration details of the component.
componentArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the component.
string
[REQUIRED]
The parent image of the image recipe.
list
The block device mappings of the image 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 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.
dict
The tags of the image recipe.
(string) --
(string) --
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageRecipeArn': '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.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe that was created by this request.
Applies a policy to an image recipe.
See also: AWS API Documentation
Request Syntax
client.put_image_recipe_policy(
imageRecipeArn='string',
policy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
string
[REQUIRED]
The policy to apply.
dict
Response Syntax
{
'requestId': 'string',
'imageRecipeArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
Deletes a distribution configuration.
See also: AWS API Documentation
Request Syntax
client.delete_distribution_configuration(
distributionConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration to delete.
dict
Response Syntax
{
'requestId': 'string',
'distributionConfigurationArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
Imports a component and transforms its data into a component document.
See also: AWS API Documentation
Request Syntax
client.import_component(
name='string',
semanticVersion='string',
description='string',
changeDescription='string',
type='BUILD'|'TEST',
format='SHELL',
platform='Windows'|'Linux',
data='string',
uri='string',
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The semantic version of the component. This version to follow the semantic version syntax. i.e. major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.
string
The description of the component. Describes the contents of the component.
string
The change description of the component. Describes what change has been made in this version. In other words what makes this version different from other versions of this component.
string
[REQUIRED]
The type of the component denotes whether the component is used to build the image or only to test it.
string
[REQUIRED]
The format of the resource that you wish to import as a component.
string
[REQUIRED]
The platform of the component.
string
The data of the component.
string
The uri of the component.
string
The ID of the KMS key that should be used to encrypt this component.
dict
The tags of the component.
(string) --
(string) --
string
[REQUIRED]
The idempotency token of the component.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'componentBuildVersionArn': '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.
componentBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the imported component.
Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
See also: AWS API Documentation
Request Syntax
client.create_image(
imageRecipeArn='string',
distributionConfigurationArn='string',
infrastructureConfigurationArn='string',
imageTestsConfiguration={
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested and assessed.
string
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
dict
The image tests configuration of the 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 for.
dict
The tags of the image.
(string) --
(string) --
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageBuildVersionArn': '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.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image that was created by this request.
Deletes an infrastructure configuration.
See also: AWS API Documentation
Request Syntax
client.delete_infrastructure_configuration(
infrastructureConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
dict
Response Syntax
{
'requestId': 'string',
'infrastructureConfigurationArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
Gets a component policy.
See also: AWS API Documentation
Request Syntax
client.get_component_policy(
componentArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the component whose policy you wish to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'policy': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
policy (string) --
The component policy.
Gets a infrastructure configuration.
See also: AWS API Documentation
Request Syntax
client.get_infrastructure_configuration(
infrastructureConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to retrieve.
dict
Response Syntax
{
'requestId': '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',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
GetInfrastructureConfiguration response object.
requestId (string) --
The request ID that uniquely identifies this request.
infrastructureConfiguration (dict) --
The infrastructure configuration object.
arn (string) --
The Amazon Resource Name (ARN) of the infrastruction configuration.
name (string) --
The name of the infrastruction configuration.
description (string) --
The description of the infrastruction configuration.
instanceTypes (list) --
The instance types of the infrastruction configuration.
(string) --
instanceProfileName (string) --
The instance profile of the infrastruction configuration.
securityGroupIds (list) --
The security group IDs of the infrastruction configuration.
(string) --
subnetId (string) --
The subnet ID of the infrastruction configuration.
logging (dict) --
The logging configuration of the infrastruction configuration.
s3Logs (dict) --
The S3 logging configuration.
s3BucketName (string) --
The S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The S3 path in which to store the logs.
keyPair (string) --
The EC2 key pair of the infrastruction configuration.
terminateInstanceOnFailure (boolean) --
The terminate instance on failure configuration of the infrastruction configuration.
snsTopicArn (string) --
The SNS Topic Amazon Resource Name (ARN) of the infrastruction configuration.
dateCreated (string) --
The date on which the infrastructure configuration was created.
dateUpdated (string) --
The date on which the infrastructure configuration was last updated.
tags (dict) --
The tags of the infrastruction configuration.
(string) --
(string) --
Returns the list of image build versions for the specified semantic version.
See also: AWS API Documentation
Request Syntax
client.list_images(
owner='Self'|'Shared'|'Amazon',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
The owner defines whose images you wish to list. By default this request will only show images owned by your account. You may use this field to specify if you wish to view images owned by yourself, Amazon, or those images that have been shared with you by other customers.
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'imageVersionList': [
{
'arn': 'string',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'dateCreated': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageVersionList (list) --
The list of image semantic versions.
(dict) --
An image semantic version.
arn (string) --
The Amazon Resource Name (ARN) of the image semantic verion.
name (string) --
The name of the image semantic version.
version (string) --
The semantic version of the image semantic version.
platform (string) --
The platform of the image semantic version.
owner (string) --
The owner of the image semantic version.
dateCreated (string) --
The date at which this image semantic version was created.
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Returns a list of infrastructure configurations.
See also: AWS API Documentation
Request Syntax
client.list_infrastructure_configurations(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'infrastructureConfigurationSummaryList': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
infrastructureConfigurationSummaryList (list) --
The list of infrastructure configurations.
(dict) --
The infrastructure used when building EC2 AMIs.
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.
dateCreated (string) --
The date on which the infrastructure configuration was created.
dateUpdated (string) --
The date on which the infrastructure configuration was last updated.
tags (dict) --
The tags of the infrastructure configuration.
(string) --
(string) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Manually triggers a pipeline to create an image.
See also: AWS API Documentation
Request Syntax
client.start_image_pipeline_execution(
imagePipelineArn='string',
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image pipeline that you wish to manually invoke.
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageBuildVersionArn': '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.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image that was created by this request.
Returns a list of images created by the specified pipeline.
See also: AWS API Documentation
Request Syntax
client.list_image_pipeline_images(
imagePipelineArn='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
The Amazon Resource Name (ARN) of the image pipeline whose images you wish to view.
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'imageSummaryList': [
{
'arn': 'string',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'owner': 'string',
'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'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageSummaryList (list) --
The list of images built by this pipeline.
(dict) --
An image summary.
arn (string) --
The Amazon Resource Name (ARN) of the image.
name (string) --
The name of the image.
version (string) --
The version of the image.
platform (string) --
The platform of the image.
state (dict) --
The state of the image.
status (string) --
The status of the image.
reason (string) --
The reason for the image's status.
owner (string) --
The owner of the image.
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 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 images 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) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Deletes an image.
See also: AWS API Documentation
Request Syntax
client.delete_image(
imageBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image to delete.
dict
Response Syntax
{
'requestId': 'string',
'imageBuildVersionArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image that was deleted.
Returns the list of tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags you wish to retrieve.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags for the specified resource.
(string) --
(string) --
Deletes an image pipeline.
See also: AWS API Documentation
Request Syntax
client.delete_image_pipeline(
imagePipelineArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image pipeline to delete.
dict
Response Syntax
{
'requestId': 'string',
'imagePipelineArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was deleted.
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
See also: AWS API Documentation
Request Syntax
client.create_image_pipeline(
name='string',
description='string',
imageRecipeArn='string',
infrastructureConfigurationArn='string',
distributionConfigurationArn='string',
imageTestsConfiguration={
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
schedule={
'scheduleExpression': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE'
},
status='DISABLED'|'ENABLED',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the image pipeline.
string
The description of the image pipeline.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
string
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
dict
The image test configuration of the image pipeline.
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 for.
dict
The schedule of the image pipeline.
scheduleExpression (string) --
The expression determines how often a pipeline starts the creation of new images.
pipelineExecutionStartCondition (string) --
The condition configures when the pipeline should trigger a new image build.
string
The status of the image pipeline.
dict
The tags of the image pipeline.
(string) --
(string) --
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imagePipelineArn': '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.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
Returns a list of distribution configurations.
See also: AWS API Documentation
Request Syntax
client.list_image_build_versions(
imageVersionArn='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image whose build versions you wish to retrieve.
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'imageSummaryList': [
{
'arn': 'string',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'owner': 'string',
'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'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageSummaryList (list) --
The list of image build versions.
(dict) --
An image summary.
arn (string) --
The Amazon Resource Name (ARN) of the image.
name (string) --
The name of the image.
version (string) --
The version of the image.
platform (string) --
The platform of the image.
state (dict) --
The state of the image.
status (string) --
The status of the image.
reason (string) --
The reason for the image's status.
owner (string) --
The owner of the image.
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 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 images 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) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Adds a tag to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you wish to tag.
dict
[REQUIRED]
The tags to apply to the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Applies a policy to a component.
See also: AWS API Documentation
Request Syntax
client.put_component_policy(
componentArn='string',
policy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the component that this policy should be applied to.
string
[REQUIRED]
The policy to apply.
dict
Response Syntax
{
'requestId': 'string',
'componentArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
componentArn (string) --
The Amazon Resource Name (ARN) of the component that this policy was applied to.
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
See also: AWS API Documentation
Request Syntax
client.update_infrastructure_configuration(
infrastructureConfigurationArn='string',
description='string',
instanceTypes=[
'string',
],
instanceProfileName='string',
securityGroupIds=[
'string',
],
subnetId='string',
logging={
's3Logs': {
's3BucketName': 'string',
's3KeyPrefix': 'string'
}
},
keyPair='string',
terminateInstanceOnFailure=True|False,
snsTopicArn='string',
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to update.
string
The description of the infrastructure configuration.
list
The instance types of the infrastructure configuration. You may specify one or more instance types to use for this build, the service will pick one of these instance types based on availability.
(string) --
string
The instance profile to associate with the instance used to customize your EC2 AMI.
list
The security group IDs to associate with the instance used to customize your EC2 AMI.
(string) --
string
The subnet ID to place the instance used to customize your EC2 AMI in.
dict
The logging configuration of the infrastructure configuration.
s3Logs (dict) --
The S3 logging configuration.
s3BucketName (string) --
The S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The S3 path in which to store the logs.
string
The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to create your image.
boolean
The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image Builder to retain the instance used to configure your AMI in the event that the build or test phase of your workflow failed.
string
The SNS topic on which to send image build events.
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'infrastructureConfigurationArn': '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.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
Gets an image policy.
See also: AWS API Documentation
Request Syntax
client.get_image_policy(
imageArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image whose policy you wish to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'policy': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
policy (string) --
The image policy object.
Returns a list of image recipes.
See also: AWS API Documentation
Request Syntax
client.list_image_recipes(
owner='Self'|'Shared'|'Amazon',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
The owner defines whose image recipes you wish to list. By default this request will only show image recipes owned by your account. You may use this field to specify if you wish to view image recipes owned by yourself, Amazon, or those image recipes that have been shared with you by other customers.
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'imageRecipeSummaryList': [
{
'arn': 'string',
'name': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'parentImage': 'string',
'dateCreated': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageRecipeSummaryList (list) --
The list of image pipelines.
(dict) --
A summary of an image recipe.
arn (string) --
The Amazon Resource Name (ARN) of the image recipe.
name (string) --
The name of the image recipe.
platform (string) --
The platform of the image recipe.
owner (string) --
The owner of the image recipe.
parentImage (string) --
The parent image of the image recipe.
dateCreated (string) --
The date on which this image recipe was created.
tags (dict) --
The tags of the image recipe.
(string) --
(string) --
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Returns the list of component build versions for the specified semantic version.
See also: AWS API Documentation
Request Syntax
client.list_components(
owner='Self'|'Shared'|'Amazon',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
string
The owner defines whose components you wish to list. By default this request will only show components owned by your account. You may use this field to specify if you wish to view components owned by yourself, Amazon, or those components that have been shared with you by other customers.
list
(dict) --
name (string) --
values (list) --
(string) --
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'componentVersionList': [
{
'arn': 'string',
'name': 'string',
'version': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'type': 'BUILD'|'TEST',
'owner': 'string',
'dateCreated': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
componentVersionList (list) --
The list of component semantic versions.
(dict) --
A high level overview of a component semantic version.
arn (string) --
The Amazon Resource Name (ARN) of the component.
name (string) --
The name of the component.
version (string) --
The semantic version of the component.
description (string) --
The description of the component.
platform (string) --
The platform of the component.
type (string) --
The type of the component denotes whether the component is used to build the image or only to test it.
owner (string) --
The owner of the component.
dateCreated (string) --
The date that the component was created.
nextToken (string) --
The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
Creates a new component that can be used to build, validate, test and assess your image.
See also: AWS API Documentation
Request Syntax
client.create_component(
name='string',
semanticVersion='string',
description='string',
changeDescription='string',
platform='Windows'|'Linux',
data='string',
uri='string',
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The semantic version of the component. This version to follow the semantic version syntax. i.e. major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.
string
CThe description of the component. Describes the contents of the component.
string
CThe change description of the component. Describes what change has been made in this version. In other words what makes this version different from other versions of this component.
string
[REQUIRED]
CThe platform of the component.
string
CThe data of the component.
string
CThe uri of the component.
string
The ID of the KMS key that should be used to encrypt this component.
dict
CThe tags of the component.
(string) --
(string) --
string
[REQUIRED]
CThe idempotency token of the component.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'componentBuildVersionArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
CThe request ID that uniquely identifies this request.
clientToken (string) --
CThe idempotency token used to make this request idempotent.
componentBuildVersionArn (string) --
CThe Amazon Resource Name (ARN) of the component that was created by this request.
CancelImageCreation cancels the creation of Image. This operation may only be used on images in a non-terminal state.
See also: AWS API Documentation
Request Syntax
client.cancel_image_creation(
imageBuildVersionArn='string',
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image whose creation you wish to cancel.
string
[REQUIRED]
The idempotency token used to make this request idempotent.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageBuildVersionArn': '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.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image whose creation has been cancelled.
Gets a component object.
See also: AWS API Documentation
Request Syntax
client.get_component(
componentBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the component that you wish to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'component': {
'arn': 'string',
'name': 'string',
'version': 'string',
'description': 'string',
'changeDescription': 'string',
'type': 'BUILD'|'TEST',
'platform': 'Windows'|'Linux',
'owner': 'string',
'data': 'string',
'kmsKeyId': 'string',
'encrypted': True|False,
'dateCreated': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
component (dict) --
The component object associated with the specified ARN.
arn (string) --
The Amazon Resource Name (ARN) of the component.
name (string) --
The name of the component.
version (string) --
The version of the component.
description (string) --
The description of the component.
changeDescription (string) --
The change description of the component.
type (string) --
The type of the component denotes whether the component is used to build the image or only to test it.
platform (string) --
The platform of the component.
owner (string) --
The owner of the component.
data (string) --
The data of the component.
kmsKeyId (string) --
The KMS key identifier used to encrypt the component.
encrypted (boolean) --
The encryption status of the component.
dateCreated (string) --
The date that the component was created.
tags (dict) --
The tags associated with the component.
(string) --
(string) --
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
See also: AWS API Documentation
Request Syntax
client.create_infrastructure_configuration(
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',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the infrastructure configuration.
string
The description of the infrastructure configuration.
list
The instance types of the infrastructure configuration. You may specify one or more instance types to use for this build, the service will pick one of these instance types based on availability.
(string) --
string
[REQUIRED]
The instance profile to associate with the instance used to customize your EC2 AMI.
list
The security group IDs to associate with the instance used to customize your EC2 AMI.
(string) --
string
The subnet ID to place the instance used to customize your EC2 AMI in.
dict
The logging configuration of the infrastructure configuration.
s3Logs (dict) --
The S3 logging configuration.
s3BucketName (string) --
The S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The S3 path in which to store the logs.
string
The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to create your image.
boolean
The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image Builder to retain the instance used to configure your AMI in the event that the build or test phase of your workflow failed.
string
The SNS topic on which to send image build events.
dict
The tags of the infrastructure configuration.
(string) --
(string) --
string
[REQUIRED]
The idempotency token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'infrastructureConfigurationArn': '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.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
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'
},
'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) --
region (string) -- [REQUIRED]
amiDistributionConfiguration (dict) --
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) --
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
(string) --
userGroups (list) --
(string) --
licenseConfigurationArns (list) --
(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.