Skip to content

publish_type

Operation

publish_type

publish_type(request: PublishTypeInput | PublishTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PublishTypeInputDict]) -> PublishTypeOutput

Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

Parameters:

Name Type Description Default
request PublishTypeInput | PublishTypeInputDict | 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[PublishTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PublishTypeOutput

An instance of PublishTypeOutput.

publish_type async

publish_type(request: PublishTypeInput | PublishTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PublishTypeInputDict]) -> PublishTypeOutput

Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

Parameters:

Name Type Description Default
request PublishTypeInput | PublishTypeInputDict | 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[PublishTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PublishTypeOutput

An instance of PublishTypeOutput.

Input

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

PublishTypeInputDict

Bases: TypedDict

Dictionary form of PublishTypeInput.

Attributes

arn instance-attribute
arn: str | None

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

public_version_number instance-attribute
public_version_number: str | None

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

type instance-attribute
type: str | None

The type of the extension.

Conditional: You must specify Arn, or TypeName and Type.

type_name instance-attribute
type_name: str | None

The name of the extension.

Conditional: You must specify Arn, or TypeName and Type.

PublishTypeInput dataclass

Bases: _SerdeShape

Dataclass for PublishTypeInput structure.

Attributes

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

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

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

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

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

The type of the extension.

Conditional: You must specify Arn, or TypeName and Type.

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

The name of the extension.

Conditional: You must specify Arn, or TypeName and Type.

Output

PublishTypeOutput dataclass

Bases: _SerdeShape

Dataclass for PublishTypeOutput structure.

Attributes

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

The Amazon Resource Name (ARN) assigned to the public extension upon publication.

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.