AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeIndexOutput

import "github.com/aws/aws-sdk-go/service/iot"

type DescribeIndexOutput struct { IndexName *string `locationName:"indexName" min:"1" type:"string"` IndexStatus *string `locationName:"indexStatus" type:"string" enum:"IndexStatus"` Schema *string `locationName:"schema" type:"string"` }

IndexName

Type: *string

The index name.

IndexStatus

Type: *string

The index status.

Schema

Type: *string

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index will contain only registry data.

  • REGISTRY_AND_SHADOW - Your thing index will contain registry data and shadow data.

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index will contain registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index will contain registry data, shadow data, and thing connectivity status data.

Method

GoString

func (s DescribeIndexOutput) GoString() string

GoString returns the string representation

SetIndexName

func (s *DescribeIndexOutput) SetIndexName(v string) *DescribeIndexOutput

SetIndexName sets the IndexName field's value.

SetIndexStatus

func (s *DescribeIndexOutput) SetIndexStatus(v string) *DescribeIndexOutput

SetIndexStatus sets the IndexStatus field's value.

SetSchema

func (s *DescribeIndexOutput) SetSchema(v string) *DescribeIndexOutput

SetSchema sets the Schema field's value.

String

func (s DescribeIndexOutput) String() string

String returns the string representation

On this page: