Skip to content

get_configuration_bundle

Operation

get_configuration_bundle

get_configuration_bundle(request: GetConfigurationBundleInput | GetConfigurationBundleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetConfigurationBundleInputDict]) -> GetConfigurationBundleOutput

Gets the latest version of a configuration bundle. By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to retrieve a specific historical version.

Parameters:

Name Type Description Default
request GetConfigurationBundleInput | GetConfigurationBundleInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetConfigurationBundleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetConfigurationBundleOutput

An instance of GetConfigurationBundleOutput.

get_configuration_bundle async

get_configuration_bundle(request: GetConfigurationBundleInput | GetConfigurationBundleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetConfigurationBundleInputDict]) -> GetConfigurationBundleOutput

Gets the latest version of a configuration bundle. By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to retrieve a specific historical version.

Parameters:

Name Type Description Default
request GetConfigurationBundleInput | GetConfigurationBundleInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetConfigurationBundleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetConfigurationBundleOutput

An instance of GetConfigurationBundleOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetConfigurationBundleInputDict

Bases: TypedDict

Dictionary form of GetConfigurationBundleInput.

Attributes

branch_name instance-attribute
branch_name: str | None

The branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.

bundle_id instance-attribute
bundle_id: Required[str]

The unique identifier of the configuration bundle to retrieve.

GetConfigurationBundleInput dataclass

Bases: _SerdeShape

Dataclass for GetConfigurationBundleInput structure.

Attributes

branch_name class-attribute instance-attribute
branch_name: str | None = ...

The branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.

bundle_id class-attribute instance-attribute
bundle_id: str | None = ...

The unique identifier of the configuration bundle to retrieve.

Output

GetConfigurationBundleOutput dataclass

Bases: _SerdeShape

Dataclass for GetConfigurationBundleOutput structure.

Attributes

bundle_arn instance-attribute
bundle_arn: str

The Amazon Resource Name (ARN) of the configuration bundle.

bundle_id instance-attribute
bundle_id: str

The unique identifier of the configuration bundle.

bundle_name instance-attribute
bundle_name: str

The name of the configuration bundle.

components instance-attribute

A map of component identifiers to their configurations for this version.

created_at instance-attribute
created_at: datetime

The timestamp when the configuration bundle was created.

description class-attribute instance-attribute
description: str | None = ...

The description of the configuration bundle.

kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = ...

KMS key ARN used to encrypt component configurations, if CMK was provided.

lineage_metadata class-attribute instance-attribute
lineage_metadata: VersionLineageMetadata | None = ...

The version lineage metadata, including parent versions, branch name, and creation source.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

updated_at instance-attribute
updated_at: datetime

The timestamp when the configuration bundle was last updated.

version_id instance-attribute
version_id: str

The version identifier of this configuration bundle.