AppStream / Paginator / DescribeImages

DescribeImages#

class AppStream.Paginator.DescribeImages#

paginator = client.get_paginator('describe_images')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from AppStream.Client.describe_images().

Request Syntax

response_iterator = paginator.paginate(
    Names=[
        'string',
    ],
    Arns=[
        'string',
    ],
    Type='PUBLIC'|'PRIVATE'|'SHARED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Names (list) –
The names of the public or private images to describe.
- (string) –
Arns (list) –
The ARNs of the public, private, and shared images to describe.
- (string) –
Type (string) – The type of image (public, private, or shared) to describe.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Images': [
        {
            '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'|'WINDOWS_SERVER_2022'|'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'|'WINDOWS_SERVER_2022'|'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

(dict) –
- Images (list) –
  
  Information about the images.
  - (dict) –
    
    Describes an image.
    - Name (string) –
      
      The name of the image.
    - Arn (string) –
      
      The ARN of the image.
    - BaseImageArn (string) –
      
      The ARN of the image from which this image was created.
    - DisplayName (string) –
      
      The image name to display.
    - State (string) –
      
      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
    - Visibility (string) –
      
      Indicates whether the image is public or private.
    - ImageBuilderSupported (boolean) –
      
      Indicates whether an image builder can be launched from this image.
    - ImageBuilderName (string) –
      
      The name of the image builder that was used to create the private image. If the image is shared, this value is null.
    - Platform (string) –
      
      The operating system platform of the image.
    - Description (string) –
      
      The description to display.
    - StateChangeReason (dict) –
      
      The reason why the last state change occurred.
      - Code (string) –
        
        The state change reason code.
      - Message (string) –
        
        The state change reason message.
    - Applications (list) –
      
      The applications associated with the image.
      - (dict) –
        
        Describes an application in the application catalog.
        
        Name (string) –
        
        The name of the application.
        
        DisplayName (string) –
        
        The application name to display.
        
        IconURL (string) –
        
        The URL for the application icon. This URL might be time-limited.
        
        LaunchPath (string) –
        
        The path to the application executable in the instance.
        
        LaunchParameters (string) –
        
        The arguments that are passed to the application at launch.
        
        Enabled (boolean) –
        
        If there is a problem, the application can be disabled after image creation.
        
        Metadata (dict) –
        
        Additional attributes that describe the application.
        
        (string) –
        
        (string) –
        
        WorkingDirectory (string) –
        
        The working directory for the application.
        
        Description (string) –
        
        The description of the application.
        
        Arn (string) –
        
        The ARN of the application.
        
        AppBlockArn (string) –
        
        The app block ARN of the application.
        
        IconS3Location (dict) –
        
        The S3 location of the application icon.
        
        S3Bucket (string) –
        
        The S3 bucket of the S3 object.
        
        S3Key (string) –
        
        The S3 key of the S3 object.
        
        This is required when used for the following:
        
        IconS3Location (Actions: CreateApplication and UpdateApplication)
        
        SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
        
        ScriptDetails (Actions: CreateAppBlock)
        
        SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
        
        SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
        
        Platforms (list) –
        
        The platforms on which the application can run.
        
        (string) –
        
        InstanceFamilies (list) –
        
        The instance families for the application.
        
        (string) –
        
        CreatedTime (datetime) –
        
        The time at which the application was created within the app block.
    - CreatedTime (datetime) –
      
      The time the image was created.
    - PublicBaseImageReleasedDate (datetime) –
      
      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.
    - AppstreamAgentVersion (string) –
      
      The version of the AppStream 2.0 agent to use for instances that are launched from this image.
    - ImagePermissions (dict) –
      
      The permissions to provide to the destination AWS account for the specified image.
      - allowFleet (boolean) –
        
        Indicates whether the image can be used for a fleet.
      - allowImageBuilder (boolean) –
        
        Indicates whether the image can be used for an image builder.
    - ImageErrors (list) –
      
      Describes the errors that are returned when a new image can’t be created.
      - (dict) –
        
        Describes a resource error.
        
        ErrorCode (string) –
        
        The error code.
        
        ErrorMessage (string) –
        
        The error message.
        
        ErrorTimestamp (datetime) –
        
        The time the error occurred.