Skip to content

describe_feature_group async

describe_feature_group(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    feature_group_name: Optional[FeatureGroupNameOrArn] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeFeatureGroupResponse

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

Parameters:

  • feature_group_name (Optional[FeatureGroupNameOrArn], default: None ) –

    The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

  • next_token (Optional[NextToken], default: None ) –

    A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_feature_group(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    feature_group_name: Optional[
        "capo_sagemaker.types.feature_group_name_or_arn.FeatureGroupNameOrArn"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
) -> "capo_sagemaker.types.describe_feature_group_response.DescribeFeatureGroupResponse":
    """<p>Use this operation to describe a <code>FeatureGroup</code>. The response includes information on the creation time, <code>FeatureGroup</code> name, the unique identifier for each <code>FeatureGroup</code>, and more.</p>

    Args:
        feature_group_name: <p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> you want described. </p>
        next_token: <p>A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>). 2,500 <code>Features</code> are returned by default.</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_feature_group_request.DescribeFeatureGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_feature_group_response.DescribeFeatureGroupResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_feature_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFeatureGroup")
    )
    input_: capo_sagemaker.types.describe_feature_group_request.DescribeFeatureGroupRequest = {}
    if feature_group_name is not None:
        input_["feature_group_name"] = feature_group_name
    if next_token is not None:
        input_["next_token"] = next_token

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