AppStream.Client.delete_image(**kwargs)¶Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
See also: AWS API Documentation
Request Syntax
response = client.delete_image(
Name='string'
)
[REQUIRED]
The name of the image.
{
'Image': {
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
'Message': 'string'
},
'Applications': [
{
'Name': 'string',
'DisplayName': 'string',
'IconURL': 'string',
'LaunchPath': 'string',
'LaunchParameters': 'string',
'Enabled': True|False,
'Metadata': {
'string': 'string'
},
'WorkingDirectory': 'string',
'Description': 'string',
'Arn': 'string',
'AppBlockArn': 'string',
'IconS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'Platforms': [
'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
},
'ImageErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
]
}
}
Response Structure
Information about the image.
The name of the image.
The ARN of the image.
The ARN of the image from which this image was created.
The image name to display.
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Indicates whether the image is public or private.
Indicates whether an image builder can be launched from this image.
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
The operating system platform of the image.
The description to display.
The reason why the last state change occurred.
The state change reason code.
The state change reason message.
The applications associated with the image.
Describes an application in the application catalog.
The name of the application.
The application name to display.
The URL for the application icon. This URL might be time-limited.
The path to the application executable in the instance.
The arguments that are passed to the application at launch.
If there is a problem, the application can be disabled after image creation.
Additional attributes that describe the application.
The working directory for the application.
The description of the application.
The ARN of the application.
The app block ARN of the application.
The S3 location of the application icon.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
The platforms on which the application can run.
The instance families for the application.
The time at which the application was created within the app block.
The time the image was created.
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
The permissions to provide to the destination AWS account for the specified image.
Indicates whether the image can be used for a fleet.
Indicates whether the image can be used for an image builder.
Describes the errors that are returned when a new image can't be created.
Describes a resource error.
The error code.
The error message.
The time the error occurred.
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationException