Type alias DescribeResourceOptions<TOutput, TParameters, TOutputs>

DescribeResourceOptions<TOutput, TParameters, TOutputs>: {
    assignOutput: DescribeOutputAssigner<TOutput, TParameters, TOutputs>;
    base64Tobase64url: Transcoder;
    clients: DescribeResourceClients;
    config: DescribeResourceConfig;
    determineStatusMessage?: DescribeStatusMessageDeterminer;
    exceptions: DescribeResourceExceptions;
    handleError?: DescribeResourceErrorHandler;
    name: string | undefined;
    namespace: string;
    resourceName?: string;
}

Type Parameters

  • TOutput extends object

  • TParameters extends object

  • TOutputs extends object

Type declaration

  • assignOutput: DescribeOutputAssigner<TOutput, TParameters, TOutputs>

    Called to assign the customer-given name of the resource to an output property.

  • base64Tobase64url: Transcoder

    A base64 to base64url transcoder.

  • clients: DescribeResourceClients

    The required AWS clients.

  • config: DescribeResourceConfig

    The required SDK client config.

  • Optional determineStatusMessage?: DescribeStatusMessageDeterminer

    Called to determine the statusMessage when possible.

  • exceptions: DescribeResourceExceptions

    SDK exception classes for each of the common errors.

  • Optional handleError?: DescribeResourceErrorHandler

    Called when an unhandled error is thrown. Can either throw an error or return.

  • name: string | undefined

    The customer-provided name of the resource.

  • namespace: string

    Prefix for Service Catalog provisioned product names, for example: ff.

  • Optional resourceName?: string

    The name of the Stedi product resource, for example function.