Skip to content

describe_publisher

describe_publisher(
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    publisher_id: Optional[PublisherId] = None,
) -> DescribePublisherOutput

Returns information about a CloudFormation extension publisher.

If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

For more information about registering as a publisher, see:

Parameters:

  • publisher_id (Optional[PublisherId], default: None ) –

    The ID of the extension publisher.

    If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

Raises:

Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
def describe_publisher(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    publisher_id: Optional[
        "capo_cloudformation.types.publisher_id.PublisherId"
    ] = None,
) -> "capo_cloudformation.types.describe_publisher_output.DescribePublisherOutput":
    """<p>Returns information about a CloudFormation extension publisher.</p> <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension publisher, <code>DescribePublisher</code> returns information about your own publisher account.</p> <p>For more information about registering as a publisher, see:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i> </p> </li> </ul>

    Args:
        publisher_id: <p>The ID of the extension publisher.</p> <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension publisher, <code>DescribePublisher</code> returns information about your own publisher account.</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.describe_publisher_input.DescribePublisherInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_publisher_output.DescribePublisherOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_publisher

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePublisher")
    )
    input_: capo_cloudformation.types.describe_publisher_input.DescribePublisherInput = {}
    if publisher_id is not None:
        input_["publisher_id"] = publisher_id

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