AWS API Changes

2020/05/14 - EC2 Image Builder - 4 updated api methods

Changes Update imagebuilder client to latest version

CreateComponent (updated)

Link ¶
Changes (request)

{'supportedOsVersions': ['string']}

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',
    supportedOsVersions=[
        'string',
    ],
    data='string',
    uri='string',
    kmsKeyId='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)

type name:

string

param name:

[REQUIRED]

The name of the component.

type semanticVersion:

string

param semanticVersion:

[REQUIRED]

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

type description:

string

param description:

The description of the component. Describes the contents of the component.

type changeDescription:

string

param changeDescription:

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

type platform:

string

param platform:

[REQUIRED]

The platform of the component.

type supportedOsVersions:

list

param supportedOsVersions:

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

(string) --

type data:

string

param data:

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

type uri:

string

param uri:

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

type kmsKeyId:

string

param kmsKeyId:

The ID of the KMS key that should be used to encrypt this component.

type tags:

dict

param tags:

The tags of the component.

(string) --
- (string) --

type clientToken:

string

param clientToken:

[REQUIRED]

The idempotency token of the component.

This field is autopopulated if not provided.

rtype:

dict

returns:

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 component that was created by this request.

GetComponent (updated)

Link ¶
Changes (response)

{'component': {'supportedOsVersions': ['string']}}

Gets a component object.

See also: AWS API Documentation

Request Syntax

client.get_component(
    componentBuildVersionArn='string'
)

type componentBuildVersionArn:

string

param componentBuildVersionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/d+$" suffix.

rtype:

dict

returns:

Response Syntax

{
    'requestId': 'string',
    'component': {
        'arn': 'string',
        'name': 'string',
        'version': 'string',
        'description': 'string',
        'changeDescription': 'string',
        'type': 'BUILD'|'TEST',
        'platform': 'Windows'|'Linux',
        'supportedOsVersions': [
            'string',
        ],
        '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.
  - supportedOsVersions (list) --
    
    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
    - (string) --
  - 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) --

ListComponentBuildVersions (updated)

Link ¶
Changes (response)

{'componentSummaryList': {'supportedOsVersions': ['string']}}

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'
)

type componentVersionArn:

string

param componentVersionArn:

[REQUIRED]

The component version Amazon Resource Name (ARN) whose versions you want to list.

type maxResults:

integer

param maxResults:

The maximum items to return in a request.

type nextToken:

string

param nextToken:

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

rtype:

dict

returns:

Response Syntax

{
    'requestId': 'string',
    'componentSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'version': 'string',
            'platform': 'Windows'|'Linux',
            'supportedOsVersions': [
                'string',
            ],
            '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.
    - supportedOsVersions (list) --
      
      The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
      - (string) --
    - 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, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

ListComponents (updated)

Link ¶
Changes (response)

{'componentVersionList': {'supportedOsVersions': ['string']}}

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'
)

type owner:

string

param owner:

The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.

type filters:

list

param filters:

The filters.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
- name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- values (list) --
  
  The filter values. Filter values are case-sensitive.
  - (string) --

type maxResults:

integer

param maxResults:

The maximum items to return in a request.

type nextToken:

string

param nextToken:

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

rtype:

dict

returns:

Response Syntax

{
    'requestId': 'string',
    'componentVersionList': [
        {
            'arn': 'string',
            'name': 'string',
            'version': 'string',
            'description': 'string',
            'platform': 'Windows'|'Linux',
            'supportedOsVersions': [
                'string',
            ],
            '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.
    - supportedOsVersions (list) --
      
      The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
      - (string) --
    - 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, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.