Skip to content

update_configuration_bundle

Operation

update_configuration_bundle

update_configuration_bundle(request: UpdateConfigurationBundleInput | UpdateConfigurationBundleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateConfigurationBundleInputDict]) -> UpdateConfigurationBundleOutput

Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.

Parameters:

Name Type Description Default
request UpdateConfigurationBundleInput | UpdateConfigurationBundleInputDict | 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[UpdateConfigurationBundleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateConfigurationBundleOutput

An instance of UpdateConfigurationBundleOutput.

update_configuration_bundle async

update_configuration_bundle(request: UpdateConfigurationBundleInput | UpdateConfigurationBundleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateConfigurationBundleInputDict]) -> UpdateConfigurationBundleOutput

Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.

Parameters:

Name Type Description Default
request UpdateConfigurationBundleInput | UpdateConfigurationBundleInputDict | 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[UpdateConfigurationBundleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateConfigurationBundleOutput

An instance of UpdateConfigurationBundleOutput.

Input

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

UpdateConfigurationBundleInputDict

Bases: TypedDict

Dictionary form of UpdateConfigurationBundleInput.

Attributes

branch_name instance-attribute
branch_name: str | None

The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.

bundle_id instance-attribute
bundle_id: Required[str]

The unique identifier of the configuration bundle to update.

bundle_name instance-attribute
bundle_name: str | None

The updated name for the configuration bundle.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

commit_message instance-attribute
commit_message: Required[str]

A commit message describing the changes in this version.

components instance-attribute

The updated component configurations. Creates a new version of the bundle.

created_by instance-attribute

The source that created this version, including the source name and optional ARN.

description instance-attribute
description: str | None

The updated description for the configuration bundle.

kms_key_arn instance-attribute
kms_key_arn: str | None

Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.

parent_version_ids instance-attribute
parent_version_ids: Required[Sequence[str]]

A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.

UpdateConfigurationBundleInput dataclass

Bases: _SerdeShape

Dataclass for UpdateConfigurationBundleInput structure.

Attributes

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

The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.

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

The unique identifier of the configuration bundle to update.

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

The updated name for the configuration bundle.

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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

A commit message describing the changes in this version.

components class-attribute instance-attribute
components: dict[str, ComponentConfiguration] | None = ...

The updated component configurations. Creates a new version of the bundle.

created_by class-attribute instance-attribute
created_by: VersionCreatedBySource | None = ...

The source that created this version, including the source name and optional ARN.

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

The updated description for the configuration bundle.

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

Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.

parent_version_ids class-attribute instance-attribute
parent_version_ids: list[str] | None = ...

A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.

Output

UpdateConfigurationBundleOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateConfigurationBundleOutput structure.

Attributes

bundle_arn instance-attribute
bundle_arn: str

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

bundle_id instance-attribute
bundle_id: str

The unique identifier of the updated configuration bundle.

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 updated.

version_id instance-attribute
version_id: str

The new version identifier created by this update.