Skip to content

describe_partner_app async

describe_partner_app(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    arn: Optional[PartnerAppArn] = None,
    include_available_upgrade: Optional[Boolean] = None,
) -> DescribePartnerAppResponse

Gets information about a SageMaker Partner AI App.

Parameters:

  • arn (Optional[PartnerAppArn], default: None ) –

    The ARN of the SageMaker Partner AI App to describe.

  • include_available_upgrade (Optional[Boolean], default: None ) –

    When set to TRUE, the response includes available upgrade information for the SageMaker Partner AI App. Default is FALSE.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_partner_app(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    arn: Optional["capo_sagemaker.types.partner_app_arn.PartnerAppArn"] = None,
    include_available_upgrade: Optional[
        "capo_sagemaker.types.boolean.Boolean"
    ] = None,
) -> (
    "capo_sagemaker.types.describe_partner_app_response.DescribePartnerAppResponse"
):
    """<p>Gets information about a SageMaker Partner AI App.</p>

    Args:
        arn: <p>The ARN of the SageMaker Partner AI App to describe.</p>
        include_available_upgrade: <p>When set to <code>TRUE</code>, the response includes available upgrade information for the SageMaker Partner AI App. Default is <code>FALSE</code>.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.describe_partner_app_request.DescribePartnerAppRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_partner_app_response.DescribePartnerAppResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_partner_app

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.describe_partner_app.async_describe_partner_app(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePartnerApp")
    )
    input_: capo_sagemaker.types.describe_partner_app_request.DescribePartnerAppRequest = {}
    if arn is not None:
        input_["arn"] = arn
    if include_available_upgrade is not None:
        input_["include_available_upgrade"] = include_available_upgrade

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output