Skip to content

register_publisher

register_publisher(
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    accept_terms_and_conditions: Optional[AcceptTermsAndConditions] = None,
    connection_arn: Optional[ConnectionArn] = None,
) -> RegisterPublisherOutput

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.

Parameters:

Raises:

Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
def register_publisher(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    accept_terms_and_conditions: Optional[
        "capo_cloudformation.types.accept_terms_and_conditions.AcceptTermsAndConditions"
    ] = None,
    connection_arn: Optional[
        "capo_cloudformation.types.connection_arn.ConnectionArn"
    ] = None,
) -> "capo_cloudformation.types.register_publisher_output.RegisterPublisherOutput":
    """<p>Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.</p> <p>For information about requirements for registering as a public extension publisher, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Prerequisite: Registering your account to publish CloudFormation extensions</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> <p></p>

    Args:
        accept_terms_and_conditions: <p>Whether you accept the <a href="https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf">Terms and Conditions</a> for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.</p> <p>The default is <code>false</code>.</p>
        connection_arn: <p>If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Prerequisite: Registering your account to publish CloudFormation extensions</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>

    Raises:
        capo_cloudformation.errors.cfn_registry_exception.CFNRegistryException: <p>An error occurred during a CloudFormation registry operation.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.register_publisher_input.RegisterPublisherInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.register_publisher_output.RegisterPublisherOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.register_publisher

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.register_publisher.register_publisher(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RegisterPublisher")
    )
    input_: capo_cloudformation.types.register_publisher_input.RegisterPublisherInput = {}
    if accept_terms_and_conditions is not None:
        input_["accept_terms_and_conditions"] = accept_terms_and_conditions
    if connection_arn is not None:
        input_["connection_arn"] = connection_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output