Type Alias DescribeConfigsRequest

DescribeConfigs request payload.

type DescribeConfigsRequest = {
    includeDocumentation?: boolean;
    includeSynonyms?: boolean;
    resources: readonly DescribeConfigsResource[];
    taggedFields?: readonly TaggedField[];
}

Index

Properties

includeDocumentation? includeSynonyms? resources taggedFields?

Properties

`Optional` `Readonly`includeDocumentation

includeDocumentation?: boolean

Whether to include config documentation (v3+).

`Optional` `Readonly`includeSynonyms

includeSynonyms?: boolean

Whether to include config synonyms (v1+).

`Readonly`resources

resources: readonly DescribeConfigsResource[]

Resources to describe.

`Optional` `Readonly`taggedFields

taggedFields?: readonly TaggedField[]

Tagged fields (v4+).