Skip to content

describe_portfolio_share_status

describe_portfolio_share_status(
    portfolio_share_token: Id,
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
) -> DescribePortfolioShareStatusOutput

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

Parameters:

  • portfolio_share_token (Id) –

    The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

Raises:

Source code in docs_src/capo_service_catalog/_services/service_catalog.py
def describe_portfolio_share_status(
    self,
    portfolio_share_token: "capo_service_catalog.types.id.Id",
    *,
    config_overrides: Optional[ServiceCatalogClientConfig] = None,
) -> "capo_service_catalog.types.describe_portfolio_share_status_output.DescribePortfolioShareStatusOutput":
    """<p>Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.</p>

    Args:
        portfolio_share_token: <p>The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.</p>

    Raises:
        capo_service_catalog.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the operation are not valid.</p>
        capo_service_catalog.errors.operation_not_supported_exception.OperationNotSupportedException: <p>The operation is not supported.</p>
        capo_service_catalog.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_service_catalog.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_service_catalog.types.describe_portfolio_share_status_input.DescribePortfolioShareStatusInput]",
    ) -> OperationResponse[
        "capo_service_catalog.types.describe_portfolio_share_status_output.DescribePortfolioShareStatusOutput"
    ]:
        import capo_service_catalog._operations.aws242_service_catalog_service.describe_portfolio_share_status

        output, http_response = (
            capo_service_catalog._operations.aws242_service_catalog_service.describe_portfolio_share_status.describe_portfolio_share_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePortfolioShareStatus")
    )
    input_: capo_service_catalog.types.describe_portfolio_share_status_input.DescribePortfolioShareStatusInput = {
        "portfolio_share_token": portfolio_share_token
    }

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