describe_type ¶

def describe_type(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    type: Optional["capo_cloudformation.types.registry_type.RegistryType"] = None,
    type_name: Optional["capo_cloudformation.types.type_name.TypeName"] = None,
    arn: Optional["capo_cloudformation.types.type_arn.TypeArn"] = None,
    version_id: Optional[
        "capo_cloudformation.types.type_version_id.TypeVersionId"
    ] = None,
    publisher_id: Optional[
        "capo_cloudformation.types.publisher_id.PublisherId"
    ] = None,
    public_version_number: Optional[
        "capo_cloudformation.types.public_version_number.PublicVersionNumber"
    ] = None,
) -> "capo_cloudformation.types.describe_type_output.DescribeTypeOutput":
    """<p>Returns detailed information about an extension from the CloudFormation registry in your current account and Region.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration data for extensions in your account</a> in the <i>CloudFormation User Guide</i>.</p>

    Args:
        type: <p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
        type_name: <p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
        arn: <p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>
        version_id: <p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.</p>
        publisher_id: <p>The publisher ID of the extension publisher.</p> <p>Extensions provided by Amazon Web Services are not assigned a publisher ID.</p>
        public_version_number: <p>The version number of a public third-party extension.</p>

    Raises:
        capo_cloudformation.errors.cfn_registry_exception.CFNRegistryException: <p>An error occurred during a CloudFormation registry operation.</p>
        capo_cloudformation.errors.type_not_found_exception.TypeNotFoundException: <p>The specified extension doesn't exist in the CloudFormation registry.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.describe_type_input.DescribeTypeInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_type_output.DescribeTypeOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_type

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeType")
    )
    input_: capo_cloudformation.types.describe_type_input.DescribeTypeInput = {}
    if type is not None:
        input_["type"] = type
    if type_name is not None:
        input_["type_name"] = type_name
    if arn is not None:
        input_["arn"] = arn
    if version_id is not None:
        input_["version_id"] = version_id
    if publisher_id is not None:
        input_["publisher_id"] = publisher_id
    if public_version_number is not None:
        input_["public_version_number"] = public_version_number

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