AWS API Changes

2023/02/14 - Amazon AppConfig - 3 updated api methods

Changes AWS AppConfig now offers the option to set a version label on hosted configuration versions. Version labels allow you to identify specific hosted configuration versions based on an alternate versioning scheme that you define.

CreateHostedConfigurationVersion (updated)

Link ¶
Changes (both)

{'VersionLabel': 'string'}

Creates a new configuration in the AppConfig hosted configuration store.

See also: AWS API Documentation

Request Syntax

client.create_hosted_configuration_version(
    ApplicationId='string',
    ConfigurationProfileId='string',
    Description='string',
    Content=b'bytes'|file,
    ContentType='string',
    LatestVersionNumber=123,
    VersionLabel='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type ConfigurationProfileId

string

param ConfigurationProfileId

[REQUIRED]

The configuration profile ID.

type Description

string

param Description

A description of the configuration.

type Content

bytes or seekable file-like object

param Content

[REQUIRED]

The content of the configuration or the configuration data.

type ContentType

string

param ContentType

[REQUIRED]

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

type LatestVersionNumber

integer

param LatestVersionNumber

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

type VersionLabel

string

param VersionLabel

An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'ConfigurationProfileId': 'string',
    'VersionNumber': 123,
    'Description': 'string',
    'Content': b'bytes'|file,
    'ContentType': 'string',
    'VersionLabel': 'string'
}

Response Structure

(dict) --
- ApplicationId (string) --
  
  The application ID.
- ConfigurationProfileId (string) --
  
  The configuration profile ID.
- VersionNumber (integer) --
  
  The configuration version.
- Description (string) --
  
  A description of the configuration.
- Content (bytes or seekable file-like object) --
  
  The content of the configuration or the configuration data.
- ContentType (string) --
  
  A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
- VersionLabel (string) --
  
  A user-defined label for an AppConfig hosted configuration version.

GetHostedConfigurationVersion (updated)

Link ¶
Changes (response)

{'VersionLabel': 'string'}

Retrieves information about a specific configuration version.

See also: AWS API Documentation

Request Syntax

client.get_hosted_configuration_version(
    ApplicationId='string',
    ConfigurationProfileId='string',
    VersionNumber=123
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type ConfigurationProfileId

string

param ConfigurationProfileId

[REQUIRED]

The configuration profile ID.

type VersionNumber

integer

param VersionNumber

[REQUIRED]

The version.

rtype

dict

returns

Response Syntax

{
    'ApplicationId': 'string',
    'ConfigurationProfileId': 'string',
    'VersionNumber': 123,
    'Description': 'string',
    'Content': StreamingBody(),
    'ContentType': 'string',
    'VersionLabel': 'string'
}

Response Structure

(dict) --
- ApplicationId (string) --
  
  The application ID.
- ConfigurationProfileId (string) --
  
  The configuration profile ID.
- VersionNumber (integer) --
  
  The configuration version.
- Description (string) --
  
  A description of the configuration.
- Content (:class:`.StreamingBody`) --
  
  The content of the configuration or the configuration data.
- ContentType (string) --
  
  A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
- VersionLabel (string) --
  
  A user-defined label for an AppConfig hosted configuration version.

ListHostedConfigurationVersions (updated)

Link ¶
Changes (request, response)
Request

{'VersionLabel': 'string'}

Response

{'Items': {'VersionLabel': 'string'}}

Lists configurations stored in the AppConfig hosted configuration store by version.

See also: AWS API Documentation

Request Syntax

client.list_hosted_configuration_versions(
    ApplicationId='string',
    ConfigurationProfileId='string',
    MaxResults=123,
    NextToken='string',
    VersionLabel='string'
)

type ApplicationId

string

param ApplicationId

[REQUIRED]

The application ID.

type ConfigurationProfileId

string

param ConfigurationProfileId

[REQUIRED]

The configuration profile ID.

type MaxResults

integer

param MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

type NextToken

string

param NextToken

A token to start the list. Use this token to get the next set of results.

type VersionLabel

string

param VersionLabel

An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.

rtype

dict

returns

Response Syntax

{
    'Items': [
        {
            'ApplicationId': 'string',
            'ConfigurationProfileId': 'string',
            'VersionNumber': 123,
            'Description': 'string',
            'ContentType': 'string',
            'VersionLabel': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Items (list) --
  
  The elements from this collection.
  - (dict) --
    
    Information about the configuration.
    - ApplicationId (string) --
      
      The application ID.
    - ConfigurationProfileId (string) --
      
      The configuration profile ID.
    - VersionNumber (integer) --
      
      The configuration version.
    - Description (string) --
      
      A description of the configuration.
    - ContentType (string) --
      
      A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
    - VersionLabel (string) --
      
      A user-defined label for an AppConfig hosted configuration version.
- NextToken (string) --
  
  The token for the next set of items to return. Use this token to get the next set of results.