iottwinmaker

package
v1.44.307 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2023 License: Apache-2.0 Imports: 10 Imported by: 19

Documentation

Overview

Package iottwinmaker provides the client and types for making API requests to AWS IoT TwinMaker.

IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.

See https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29 for more information on this service.

See iottwinmaker package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iottwinmaker/

Using the Client

To contact AWS IoT TwinMaker with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT TwinMaker client IoTTwinMaker for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iottwinmaker/#New

Index

Constants

View Source
const (
	// ColumnTypeNode is a ColumnType enum value
	ColumnTypeNode = "NODE"

	// ColumnTypeEdge is a ColumnType enum value
	ColumnTypeEdge = "EDGE"

	// ColumnTypeValue is a ColumnType enum value
	ColumnTypeValue = "VALUE"
)
View Source
const (
	// ComponentUpdateTypeCreate is a ComponentUpdateType enum value
	ComponentUpdateTypeCreate = "CREATE"

	// ComponentUpdateTypeUpdate is a ComponentUpdateType enum value
	ComponentUpdateTypeUpdate = "UPDATE"

	// ComponentUpdateTypeDelete is a ComponentUpdateType enum value
	ComponentUpdateTypeDelete = "DELETE"
)
View Source
const (
	// ErrorCodeValidationError is a ErrorCode enum value
	ErrorCodeValidationError = "VALIDATION_ERROR"

	// ErrorCodeInternalFailure is a ErrorCode enum value
	ErrorCodeInternalFailure = "INTERNAL_FAILURE"

	// ErrorCodeSyncInitializingError is a ErrorCode enum value
	ErrorCodeSyncInitializingError = "SYNC_INITIALIZING_ERROR"

	// ErrorCodeSyncCreatingError is a ErrorCode enum value
	ErrorCodeSyncCreatingError = "SYNC_CREATING_ERROR"

	// ErrorCodeSyncProcessingError is a ErrorCode enum value
	ErrorCodeSyncProcessingError = "SYNC_PROCESSING_ERROR"
)
View Source
const (
	// OrderAscending is a Order enum value
	OrderAscending = "ASCENDING"

	// OrderDescending is a Order enum value
	OrderDescending = "DESCENDING"
)
View Source
const (
	// OrderByTimeAscending is a OrderByTime enum value
	OrderByTimeAscending = "ASCENDING"

	// OrderByTimeDescending is a OrderByTime enum value
	OrderByTimeDescending = "DESCENDING"
)
View Source
const (
	// ParentEntityUpdateTypeUpdate is a ParentEntityUpdateType enum value
	ParentEntityUpdateTypeUpdate = "UPDATE"

	// ParentEntityUpdateTypeDelete is a ParentEntityUpdateType enum value
	ParentEntityUpdateTypeDelete = "DELETE"
)
View Source
const (
	// PricingModeBasic is a PricingMode enum value
	PricingModeBasic = "BASIC"

	// PricingModeStandard is a PricingMode enum value
	PricingModeStandard = "STANDARD"

	// PricingModeTieredBundle is a PricingMode enum value
	PricingModeTieredBundle = "TIERED_BUNDLE"
)
View Source
const (
	// PricingTierTier1 is a PricingTier enum value
	PricingTierTier1 = "TIER_1"

	// PricingTierTier2 is a PricingTier enum value
	PricingTierTier2 = "TIER_2"

	// PricingTierTier3 is a PricingTier enum value
	PricingTierTier3 = "TIER_3"

	// PricingTierTier4 is a PricingTier enum value
	PricingTierTier4 = "TIER_4"
)
View Source
const (
	// PropertyGroupUpdateTypeUpdate is a PropertyGroupUpdateType enum value
	PropertyGroupUpdateTypeUpdate = "UPDATE"

	// PropertyGroupUpdateTypeDelete is a PropertyGroupUpdateType enum value
	PropertyGroupUpdateTypeDelete = "DELETE"

	// PropertyGroupUpdateTypeCreate is a PropertyGroupUpdateType enum value
	PropertyGroupUpdateTypeCreate = "CREATE"
)
View Source
const (
	// PropertyUpdateTypeUpdate is a PropertyUpdateType enum value
	PropertyUpdateTypeUpdate = "UPDATE"

	// PropertyUpdateTypeDelete is a PropertyUpdateType enum value
	PropertyUpdateTypeDelete = "DELETE"

	// PropertyUpdateTypeCreate is a PropertyUpdateType enum value
	PropertyUpdateTypeCreate = "CREATE"
)
View Source
const (
	// ScopeEntity is a Scope enum value
	ScopeEntity = "ENTITY"

	// ScopeWorkspace is a Scope enum value
	ScopeWorkspace = "WORKSPACE"
)
View Source
const (
	// StateCreating is a State enum value
	StateCreating = "CREATING"

	// StateUpdating is a State enum value
	StateUpdating = "UPDATING"

	// StateDeleting is a State enum value
	StateDeleting = "DELETING"

	// StateActive is a State enum value
	StateActive = "ACTIVE"

	// StateError is a State enum value
	StateError = "ERROR"
)
View Source
const (
	// SyncJobStateCreating is a SyncJobState enum value
	SyncJobStateCreating = "CREATING"

	// SyncJobStateInitializing is a SyncJobState enum value
	SyncJobStateInitializing = "INITIALIZING"

	// SyncJobStateActive is a SyncJobState enum value
	SyncJobStateActive = "ACTIVE"

	// SyncJobStateDeleting is a SyncJobState enum value
	SyncJobStateDeleting = "DELETING"

	// SyncJobStateError is a SyncJobState enum value
	SyncJobStateError = "ERROR"
)
View Source
const (
	// SyncResourceStateInitializing is a SyncResourceState enum value
	SyncResourceStateInitializing = "INITIALIZING"

	// SyncResourceStateProcessing is a SyncResourceState enum value
	SyncResourceStateProcessing = "PROCESSING"

	// SyncResourceStateDeleted is a SyncResourceState enum value
	SyncResourceStateDeleted = "DELETED"

	// SyncResourceStateInSync is a SyncResourceState enum value
	SyncResourceStateInSync = "IN_SYNC"

	// SyncResourceStateError is a SyncResourceState enum value
	SyncResourceStateError = "ERROR"
)
View Source
const (
	// SyncResourceTypeEntity is a SyncResourceType enum value
	SyncResourceTypeEntity = "ENTITY"

	// SyncResourceTypeComponentType is a SyncResourceType enum value
	SyncResourceTypeComponentType = "COMPONENT_TYPE"
)
View Source
const (
	// TypeRelationship is a Type enum value
	TypeRelationship = "RELATIONSHIP"

	// TypeString is a Type enum value
	TypeString = "STRING"

	// TypeLong is a Type enum value
	TypeLong = "LONG"

	// TypeBoolean is a Type enum value
	TypeBoolean = "BOOLEAN"

	// TypeInteger is a Type enum value
	TypeInteger = "INTEGER"

	// TypeDouble is a Type enum value
	TypeDouble = "DOUBLE"

	// TypeList is a Type enum value
	TypeList = "LIST"

	// TypeMap is a Type enum value
	TypeMap = "MAP"
)
View Source
const (
	// UpdateReasonDefault is a UpdateReason enum value
	UpdateReasonDefault = "DEFAULT"

	// UpdateReasonPricingTierUpdate is a UpdateReason enum value
	UpdateReasonPricingTierUpdate = "PRICING_TIER_UPDATE"

	// UpdateReasonEntityCountUpdate is a UpdateReason enum value
	UpdateReasonEntityCountUpdate = "ENTITY_COUNT_UPDATE"

	// UpdateReasonPricingModeUpdate is a UpdateReason enum value
	UpdateReasonPricingModeUpdate = "PRICING_MODE_UPDATE"

	// UpdateReasonOverwritten is a UpdateReason enum value
	UpdateReasonOverwritten = "OVERWRITTEN"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Access is denied.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A conflict occurred.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeConnectorFailureException for service response error code
	// "ConnectorFailureException".
	//
	// The connector failed.
	ErrCodeConnectorFailureException = "ConnectorFailureException"

	// ErrCodeConnectorTimeoutException for service response error code
	// "ConnectorTimeoutException".
	//
	// The connector timed out.
	ErrCodeConnectorTimeoutException = "ConnectorTimeoutException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An unexpected error has occurred.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeQueryTimeoutException for service response error code
	// "QueryTimeoutException".
	//
	// The query timeout exception.
	ErrCodeQueryTimeoutException = "QueryTimeoutException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource wasn't found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The service quota was exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The rate exceeds the limit.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The number of tags exceeds the limit.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Failed
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "IoTTwinMaker" // Name of service.
	EndpointsID = "iottwinmaker" // ID to lookup a service endpoint with.
	ServiceID   = "IoTTwinMaker" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// GroupTypeTabular is a GroupType enum value
	GroupTypeTabular = "TABULAR"
)
View Source
const (
	// InterpolationTypeLinear is a InterpolationType enum value
	InterpolationTypeLinear = "LINEAR"
)
View Source
const (
	// SceneErrorCodeMatterportError is a SceneErrorCode enum value
	SceneErrorCodeMatterportError = "MATTERPORT_ERROR"
)

Variables

This section is empty.

Functions

func ColumnType_Values added in v1.44.139

func ColumnType_Values() []string

ColumnType_Values returns all elements of the ColumnType enum

func ComponentUpdateType_Values

func ComponentUpdateType_Values() []string

ComponentUpdateType_Values returns all elements of the ComponentUpdateType enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func GroupType_Values added in v1.44.139

func GroupType_Values() []string

GroupType_Values returns all elements of the GroupType enum

func InterpolationType_Values

func InterpolationType_Values() []string

InterpolationType_Values returns all elements of the InterpolationType enum

func OrderByTime_Values

func OrderByTime_Values() []string

OrderByTime_Values returns all elements of the OrderByTime enum

func Order_Values added in v1.44.139

func Order_Values() []string

Order_Values returns all elements of the Order enum

func ParentEntityUpdateType_Values

func ParentEntityUpdateType_Values() []string

ParentEntityUpdateType_Values returns all elements of the ParentEntityUpdateType enum

func PricingMode_Values added in v1.44.139

func PricingMode_Values() []string

PricingMode_Values returns all elements of the PricingMode enum

func PricingTier_Values added in v1.44.139

func PricingTier_Values() []string

PricingTier_Values returns all elements of the PricingTier enum

func PropertyGroupUpdateType_Values added in v1.44.139

func PropertyGroupUpdateType_Values() []string

PropertyGroupUpdateType_Values returns all elements of the PropertyGroupUpdateType enum

func PropertyUpdateType_Values

func PropertyUpdateType_Values() []string

PropertyUpdateType_Values returns all elements of the PropertyUpdateType enum

func SceneErrorCode_Values added in v1.44.256

func SceneErrorCode_Values() []string

SceneErrorCode_Values returns all elements of the SceneErrorCode enum

func Scope_Values

func Scope_Values() []string

Scope_Values returns all elements of the Scope enum

func State_Values

func State_Values() []string

State_Values returns all elements of the State enum

func SyncJobState_Values added in v1.44.156

func SyncJobState_Values() []string

SyncJobState_Values returns all elements of the SyncJobState enum

func SyncResourceState_Values added in v1.44.156

func SyncResourceState_Values() []string

SyncResourceState_Values returns all elements of the SyncResourceState enum

func SyncResourceType_Values added in v1.44.156

func SyncResourceType_Values() []string

SyncResourceType_Values returns all elements of the SyncResourceType enum

func Type_Values

func Type_Values() []string

Type_Values returns all elements of the Type enum

func UpdateReason_Values added in v1.44.139

func UpdateReason_Values() []string

UpdateReason_Values returns all elements of the UpdateReason enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Access is denied.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutPropertyError

type BatchPutPropertyError struct {

	// An object that contains information about errors returned by the BatchPutProperty
	// action.
	//
	// Entry is a required field
	Entry *PropertyValueEntry `locationName:"entry" type:"structure" required:"true"`

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" min:"1" type:"string" required:"true"`

	// The error message.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `locationName:"errorMessage" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An error returned by the BatchPutProperty action.

func (BatchPutPropertyError) GoString

func (s BatchPutPropertyError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutPropertyError) SetEntry

SetEntry sets the Entry field's value.

func (*BatchPutPropertyError) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*BatchPutPropertyError) SetErrorMessage

func (s *BatchPutPropertyError) SetErrorMessage(v string) *BatchPutPropertyError

SetErrorMessage sets the ErrorMessage field's value.

func (BatchPutPropertyError) String

func (s BatchPutPropertyError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutPropertyErrorEntry

type BatchPutPropertyErrorEntry struct {

	// A list of objects that contain information about errors returned by the BatchPutProperty
	// action.
	//
	// Errors is a required field
	Errors []*BatchPutPropertyError `locationName:"errors" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about errors returned by the BatchPutProperty action.

func (BatchPutPropertyErrorEntry) GoString

func (s BatchPutPropertyErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutPropertyErrorEntry) SetErrors

SetErrors sets the Errors field's value.

func (BatchPutPropertyErrorEntry) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutPropertyValuesInput

type BatchPutPropertyValuesInput struct {

	// An object that maps strings to the property value entries to set. Each string
	// in the mapping must be unique to this object.
	//
	// Entries is a required field
	Entries []*PropertyValueEntry `locationName:"entries" min:"1" type:"list" required:"true"`

	// The ID of the workspace that contains the properties to set.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutPropertyValuesInput) GoString

func (s BatchPutPropertyValuesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutPropertyValuesInput) SetEntries

SetEntries sets the Entries field's value.

func (*BatchPutPropertyValuesInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (BatchPutPropertyValuesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutPropertyValuesInput) Validate

func (s *BatchPutPropertyValuesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutPropertyValuesOutput

type BatchPutPropertyValuesOutput struct {

	// Entries that caused errors in the batch put operation.
	//
	// ErrorEntries is a required field
	ErrorEntries []*BatchPutPropertyErrorEntry `locationName:"errorEntries" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutPropertyValuesOutput) GoString

func (s BatchPutPropertyValuesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutPropertyValuesOutput) SetErrorEntries

SetErrorEntries sets the ErrorEntries field's value.

func (BatchPutPropertyValuesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BundleInformation added in v1.44.139

type BundleInformation struct {

	// The bundle names.
	//
	// BundleNames is a required field
	BundleNames []*string `locationName:"bundleNames" min:"1" type:"list" required:"true"`

	// The pricing tier.
	PricingTier *string `locationName:"pricingTier" type:"string" enum:"PricingTier"`
	// contains filtered or unexported fields
}

Information about the pricing bundle.

func (BundleInformation) GoString added in v1.44.139

func (s BundleInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BundleInformation) SetBundleNames added in v1.44.139

func (s *BundleInformation) SetBundleNames(v []*string) *BundleInformation

SetBundleNames sets the BundleNames field's value.

func (*BundleInformation) SetPricingTier added in v1.44.139

func (s *BundleInformation) SetPricingTier(v string) *BundleInformation

SetPricingTier sets the PricingTier field's value.

func (BundleInformation) String added in v1.44.139

func (s BundleInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ColumnDescription added in v1.44.139

type ColumnDescription struct {

	// The name of the column description.
	Name *string `locationName:"name" type:"string"`

	// The type of the column description.
	Type *string `locationName:"type" type:"string" enum:"ColumnType"`
	// contains filtered or unexported fields
}

A description of the column in the query results.

func (ColumnDescription) GoString added in v1.44.139

func (s ColumnDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnDescription) SetName added in v1.44.139

SetName sets the Name field's value.

func (*ColumnDescription) SetType added in v1.44.139

SetType sets the Type field's value.

func (ColumnDescription) String added in v1.44.139

func (s ColumnDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentPropertyGroupRequest added in v1.44.139

type ComponentPropertyGroupRequest struct {

	// The group type.
	GroupType *string `locationName:"groupType" type:"string" enum:"GroupType"`

	// The property names.
	PropertyNames []*string `locationName:"propertyNames" type:"list"`

	// The update type.
	UpdateType *string `locationName:"updateType" type:"string" enum:"PropertyGroupUpdateType"`
	// contains filtered or unexported fields
}

The component property group request.

func (ComponentPropertyGroupRequest) GoString added in v1.44.139

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentPropertyGroupRequest) SetGroupType added in v1.44.139

SetGroupType sets the GroupType field's value.

func (*ComponentPropertyGroupRequest) SetPropertyNames added in v1.44.139

SetPropertyNames sets the PropertyNames field's value.

func (*ComponentPropertyGroupRequest) SetUpdateType added in v1.44.139

SetUpdateType sets the UpdateType field's value.

func (ComponentPropertyGroupRequest) String added in v1.44.139

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentPropertyGroupResponse added in v1.44.139

type ComponentPropertyGroupResponse struct {

	// The group type.
	//
	// GroupType is a required field
	GroupType *string `locationName:"groupType" type:"string" required:"true" enum:"GroupType"`

	// A Boolean value that specifies whether the property group is inherited from
	// a parent entity
	//
	// IsInherited is a required field
	IsInherited *bool `locationName:"isInherited" type:"boolean" required:"true"`

	// The names of properties
	//
	// PropertyNames is a required field
	PropertyNames []*string `locationName:"propertyNames" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The component property group response.

func (ComponentPropertyGroupResponse) GoString added in v1.44.139

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentPropertyGroupResponse) SetGroupType added in v1.44.139

SetGroupType sets the GroupType field's value.

func (*ComponentPropertyGroupResponse) SetIsInherited added in v1.44.139

SetIsInherited sets the IsInherited field's value.

func (*ComponentPropertyGroupResponse) SetPropertyNames added in v1.44.139

SetPropertyNames sets the PropertyNames field's value.

func (ComponentPropertyGroupResponse) String added in v1.44.139

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentRequest

type ComponentRequest struct {

	// The ID of the component type.
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string"`

	// The description of the component request.
	Description *string `locationName:"description" type:"string"`

	// An object that maps strings to the properties to set in the component type.
	// Each string in the mapping must be unique to this object.
	Properties map[string]*PropertyRequest `locationName:"properties" type:"map"`

	// The property groups.
	PropertyGroups map[string]*ComponentPropertyGroupRequest `locationName:"propertyGroups" type:"map"`
	// contains filtered or unexported fields
}

An object that sets information about a component type create or update request.

func (ComponentRequest) GoString

func (s ComponentRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentRequest) SetComponentTypeId

func (s *ComponentRequest) SetComponentTypeId(v string) *ComponentRequest

SetComponentTypeId sets the ComponentTypeId field's value.

func (*ComponentRequest) SetDescription

func (s *ComponentRequest) SetDescription(v string) *ComponentRequest

SetDescription sets the Description field's value.

func (*ComponentRequest) SetProperties

func (s *ComponentRequest) SetProperties(v map[string]*PropertyRequest) *ComponentRequest

SetProperties sets the Properties field's value.

func (*ComponentRequest) SetPropertyGroups added in v1.44.139

SetPropertyGroups sets the PropertyGroups field's value.

func (ComponentRequest) String

func (s ComponentRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentRequest) Validate

func (s *ComponentRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentResponse

type ComponentResponse struct {

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The ID of the component type.
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string"`

	// The name of the property definition set in the request.
	DefinedIn *string `locationName:"definedIn" min:"1" type:"string"`

	// The description of the component type.
	Description *string `locationName:"description" type:"string"`

	// An object that maps strings to the properties to set in the component type.
	// Each string in the mapping must be unique to this object.
	Properties map[string]*PropertyResponse `locationName:"properties" type:"map"`

	// The property groups.
	PropertyGroups map[string]*ComponentPropertyGroupResponse `locationName:"propertyGroups" type:"map"`

	// The status of the component type.
	Status *Status `locationName:"status" type:"structure"`

	// The syncSource of the sync job, if this entity was created by a sync job.
	SyncSource *string `locationName:"syncSource" type:"string"`
	// contains filtered or unexported fields
}

An object that returns information about a component type create or update request.

func (ComponentResponse) GoString

func (s ComponentResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentResponse) SetComponentName

func (s *ComponentResponse) SetComponentName(v string) *ComponentResponse

SetComponentName sets the ComponentName field's value.

func (*ComponentResponse) SetComponentTypeId

func (s *ComponentResponse) SetComponentTypeId(v string) *ComponentResponse

SetComponentTypeId sets the ComponentTypeId field's value.

func (*ComponentResponse) SetDefinedIn

func (s *ComponentResponse) SetDefinedIn(v string) *ComponentResponse

SetDefinedIn sets the DefinedIn field's value.

func (*ComponentResponse) SetDescription

func (s *ComponentResponse) SetDescription(v string) *ComponentResponse

SetDescription sets the Description field's value.

func (*ComponentResponse) SetProperties

func (s *ComponentResponse) SetProperties(v map[string]*PropertyResponse) *ComponentResponse

SetProperties sets the Properties field's value.

func (*ComponentResponse) SetPropertyGroups added in v1.44.139

SetPropertyGroups sets the PropertyGroups field's value.

func (*ComponentResponse) SetStatus

func (s *ComponentResponse) SetStatus(v *Status) *ComponentResponse

SetStatus sets the Status field's value.

func (*ComponentResponse) SetSyncSource added in v1.44.156

func (s *ComponentResponse) SetSyncSource(v string) *ComponentResponse

SetSyncSource sets the SyncSource field's value.

func (ComponentResponse) String

func (s ComponentResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentTypeSummary

type ComponentTypeSummary struct {

	// The ARN of the component type.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The ID of the component type.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// The component type name.
	ComponentTypeName *string `locationName:"componentTypeName" type:"string"`

	// The date and time when the component type was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the component type.
	Description *string `locationName:"description" type:"string"`

	// The current status of the component type.
	Status *Status `locationName:"status" type:"structure"`

	// The date and time when the component type was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about a component type.

func (ComponentTypeSummary) GoString

func (s ComponentTypeSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentTypeSummary) SetArn

SetArn sets the Arn field's value.

func (*ComponentTypeSummary) SetComponentTypeId

func (s *ComponentTypeSummary) SetComponentTypeId(v string) *ComponentTypeSummary

SetComponentTypeId sets the ComponentTypeId field's value.

func (*ComponentTypeSummary) SetComponentTypeName added in v1.44.156

func (s *ComponentTypeSummary) SetComponentTypeName(v string) *ComponentTypeSummary

SetComponentTypeName sets the ComponentTypeName field's value.

func (*ComponentTypeSummary) SetCreationDateTime

func (s *ComponentTypeSummary) SetCreationDateTime(v time.Time) *ComponentTypeSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*ComponentTypeSummary) SetDescription

func (s *ComponentTypeSummary) SetDescription(v string) *ComponentTypeSummary

SetDescription sets the Description field's value.

func (*ComponentTypeSummary) SetStatus

SetStatus sets the Status field's value.

func (*ComponentTypeSummary) SetUpdateDateTime

func (s *ComponentTypeSummary) SetUpdateDateTime(v time.Time) *ComponentTypeSummary

SetUpdateDateTime sets the UpdateDateTime field's value.

func (ComponentTypeSummary) String

func (s ComponentTypeSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentUpdateRequest

type ComponentUpdateRequest struct {

	// The ID of the component type.
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string"`

	// The description of the component type.
	Description *string `locationName:"description" type:"string"`

	// The property group updates.
	PropertyGroupUpdates map[string]*ComponentPropertyGroupRequest `locationName:"propertyGroupUpdates" type:"map"`

	// An object that maps strings to the properties to set in the component type
	// update. Each string in the mapping must be unique to this object.
	PropertyUpdates map[string]*PropertyRequest `locationName:"propertyUpdates" type:"map"`

	// The update type of the component update request.
	UpdateType *string `locationName:"updateType" type:"string" enum:"ComponentUpdateType"`
	// contains filtered or unexported fields
}

The component update request.

func (ComponentUpdateRequest) GoString

func (s ComponentUpdateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentUpdateRequest) SetComponentTypeId

func (s *ComponentUpdateRequest) SetComponentTypeId(v string) *ComponentUpdateRequest

SetComponentTypeId sets the ComponentTypeId field's value.

func (*ComponentUpdateRequest) SetDescription

SetDescription sets the Description field's value.

func (*ComponentUpdateRequest) SetPropertyGroupUpdates added in v1.44.139

SetPropertyGroupUpdates sets the PropertyGroupUpdates field's value.

func (*ComponentUpdateRequest) SetPropertyUpdates

SetPropertyUpdates sets the PropertyUpdates field's value.

func (*ComponentUpdateRequest) SetUpdateType

SetUpdateType sets the UpdateType field's value.

func (ComponentUpdateRequest) String

func (s ComponentUpdateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentUpdateRequest) Validate

func (s *ComponentUpdateRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A conflict occurred.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectorFailureException

type ConnectorFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The connector failed.

func (*ConnectorFailureException) Code

Code returns the exception type name.

func (*ConnectorFailureException) Error

func (s *ConnectorFailureException) Error() string

func (ConnectorFailureException) GoString

func (s ConnectorFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectorFailureException) Message

func (s *ConnectorFailureException) Message() string

Message returns the exception's message.

func (*ConnectorFailureException) OrigErr

func (s *ConnectorFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConnectorFailureException) RequestID

func (s *ConnectorFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConnectorFailureException) StatusCode

func (s *ConnectorFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConnectorFailureException) String

func (s ConnectorFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectorTimeoutException

type ConnectorTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The connector timed out.

func (*ConnectorTimeoutException) Code

Code returns the exception type name.

func (*ConnectorTimeoutException) Error

func (s *ConnectorTimeoutException) Error() string

func (ConnectorTimeoutException) GoString

func (s ConnectorTimeoutException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectorTimeoutException) Message

func (s *ConnectorTimeoutException) Message() string

Message returns the exception's message.

func (*ConnectorTimeoutException) OrigErr

func (s *ConnectorTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConnectorTimeoutException) RequestID

func (s *ConnectorTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConnectorTimeoutException) StatusCode

func (s *ConnectorTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConnectorTimeoutException) String

func (s ConnectorTimeoutException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateComponentTypeInput

type CreateComponentTypeInput struct {

	// The ID of the component type.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `location:"uri" locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// A friendly name for the component type.
	ComponentTypeName *string `locationName:"componentTypeName" type:"string"`

	// The description of the component type.
	Description *string `locationName:"description" type:"string"`

	// Specifies the parent component type to extend.
	ExtendsFrom []*string `locationName:"extendsFrom" type:"list"`

	// An object that maps strings to the functions in the component type. Each
	// string in the mapping must be unique to this object.
	Functions map[string]*FunctionRequest `locationName:"functions" type:"map"`

	// A Boolean value that specifies whether an entity can have more than one component
	// of this type.
	IsSingleton *bool `locationName:"isSingleton" type:"boolean"`

	// An object that maps strings to the property definitions in the component
	// type. Each string in the mapping must be unique to this object.
	PropertyDefinitions map[string]*PropertyDefinitionRequest `locationName:"propertyDefinitions" type:"map"`

	PropertyGroups map[string]*PropertyGroupRequest `locationName:"propertyGroups" type:"map"`

	// Metadata that you can use to manage the component type.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the workspace that contains the component type.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateComponentTypeInput) GoString

func (s CreateComponentTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentTypeInput) SetComponentTypeId

func (s *CreateComponentTypeInput) SetComponentTypeId(v string) *CreateComponentTypeInput

SetComponentTypeId sets the ComponentTypeId field's value.

func (*CreateComponentTypeInput) SetComponentTypeName added in v1.44.156

func (s *CreateComponentTypeInput) SetComponentTypeName(v string) *CreateComponentTypeInput

SetComponentTypeName sets the ComponentTypeName field's value.

func (*CreateComponentTypeInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateComponentTypeInput) SetExtendsFrom

func (s *CreateComponentTypeInput) SetExtendsFrom(v []*string) *CreateComponentTypeInput

SetExtendsFrom sets the ExtendsFrom field's value.

func (*CreateComponentTypeInput) SetFunctions

SetFunctions sets the Functions field's value.

func (*CreateComponentTypeInput) SetIsSingleton

SetIsSingleton sets the IsSingleton field's value.

func (*CreateComponentTypeInput) SetPropertyDefinitions

SetPropertyDefinitions sets the PropertyDefinitions field's value.

func (*CreateComponentTypeInput) SetPropertyGroups added in v1.44.139

SetPropertyGroups sets the PropertyGroups field's value.

func (*CreateComponentTypeInput) SetTags

SetTags sets the Tags field's value.

func (*CreateComponentTypeInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateComponentTypeInput) String

func (s CreateComponentTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentTypeInput) Validate

func (s *CreateComponentTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComponentTypeOutput

type CreateComponentTypeOutput struct {

	// The ARN of the component type.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the entity was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The current state of the component type.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`
	// contains filtered or unexported fields
}

func (CreateComponentTypeOutput) GoString

func (s CreateComponentTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentTypeOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateComponentTypeOutput) SetCreationDateTime

func (s *CreateComponentTypeOutput) SetCreationDateTime(v time.Time) *CreateComponentTypeOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*CreateComponentTypeOutput) SetState

SetState sets the State field's value.

func (CreateComponentTypeOutput) String

func (s CreateComponentTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEntityInput

type CreateEntityInput struct {

	// An object that maps strings to the components in the entity. Each string
	// in the mapping must be unique to this object.
	Components map[string]*ComponentRequest `locationName:"components" type:"map"`

	// The description of the entity.
	Description *string `locationName:"description" type:"string"`

	// The ID of the entity.
	EntityId *string `locationName:"entityId" min:"1" type:"string"`

	// The name of the entity.
	//
	// EntityName is a required field
	EntityName *string `locationName:"entityName" min:"1" type:"string" required:"true"`

	// The ID of the entity's parent entity.
	ParentEntityId *string `locationName:"parentEntityId" min:"1" type:"string"`

	// Metadata that you can use to manage the entity.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the workspace that contains the entity.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateEntityInput) GoString

func (s CreateEntityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEntityInput) SetComponents

func (s *CreateEntityInput) SetComponents(v map[string]*ComponentRequest) *CreateEntityInput

SetComponents sets the Components field's value.

func (*CreateEntityInput) SetDescription

func (s *CreateEntityInput) SetDescription(v string) *CreateEntityInput

SetDescription sets the Description field's value.

func (*CreateEntityInput) SetEntityId

func (s *CreateEntityInput) SetEntityId(v string) *CreateEntityInput

SetEntityId sets the EntityId field's value.

func (*CreateEntityInput) SetEntityName

func (s *CreateEntityInput) SetEntityName(v string) *CreateEntityInput

SetEntityName sets the EntityName field's value.

func (*CreateEntityInput) SetParentEntityId

func (s *CreateEntityInput) SetParentEntityId(v string) *CreateEntityInput

SetParentEntityId sets the ParentEntityId field's value.

func (*CreateEntityInput) SetTags

func (s *CreateEntityInput) SetTags(v map[string]*string) *CreateEntityInput

SetTags sets the Tags field's value.

func (*CreateEntityInput) SetWorkspaceId

func (s *CreateEntityInput) SetWorkspaceId(v string) *CreateEntityInput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateEntityInput) String

func (s CreateEntityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEntityInput) Validate

func (s *CreateEntityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEntityOutput

type CreateEntityOutput struct {

	// The ARN of the entity.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the entity was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The ID of the entity.
	//
	// EntityId is a required field
	EntityId *string `locationName:"entityId" min:"1" type:"string" required:"true"`

	// The current state of the entity.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`
	// contains filtered or unexported fields
}

func (CreateEntityOutput) GoString

func (s CreateEntityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEntityOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateEntityOutput) SetCreationDateTime

func (s *CreateEntityOutput) SetCreationDateTime(v time.Time) *CreateEntityOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*CreateEntityOutput) SetEntityId

func (s *CreateEntityOutput) SetEntityId(v string) *CreateEntityOutput

SetEntityId sets the EntityId field's value.

func (*CreateEntityOutput) SetState

SetState sets the State field's value.

func (CreateEntityOutput) String

func (s CreateEntityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSceneInput

type CreateSceneInput struct {

	// A list of capabilities that the scene uses to render itself.
	Capabilities []*string `locationName:"capabilities" type:"list"`

	// The relative path that specifies the location of the content definition file.
	//
	// ContentLocation is a required field
	ContentLocation *string `locationName:"contentLocation" type:"string" required:"true"`

	// The description for this scene.
	Description *string `locationName:"description" type:"string"`

	// The ID of the scene.
	//
	// SceneId is a required field
	SceneId *string `locationName:"sceneId" min:"1" type:"string" required:"true"`

	// The request metadata.
	SceneMetadata map[string]*string `locationName:"sceneMetadata" type:"map"`

	// Metadata that you can use to manage the scene.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the workspace that contains the scene.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSceneInput) GoString

func (s CreateSceneInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSceneInput) SetCapabilities

func (s *CreateSceneInput) SetCapabilities(v []*string) *CreateSceneInput

SetCapabilities sets the Capabilities field's value.

func (*CreateSceneInput) SetContentLocation

func (s *CreateSceneInput) SetContentLocation(v string) *CreateSceneInput

SetContentLocation sets the ContentLocation field's value.

func (*CreateSceneInput) SetDescription

func (s *CreateSceneInput) SetDescription(v string) *CreateSceneInput

SetDescription sets the Description field's value.

func (*CreateSceneInput) SetSceneId

func (s *CreateSceneInput) SetSceneId(v string) *CreateSceneInput

SetSceneId sets the SceneId field's value.

func (*CreateSceneInput) SetSceneMetadata added in v1.44.227

func (s *CreateSceneInput) SetSceneMetadata(v map[string]*string) *CreateSceneInput

SetSceneMetadata sets the SceneMetadata field's value.

func (*CreateSceneInput) SetTags

func (s *CreateSceneInput) SetTags(v map[string]*string) *CreateSceneInput

SetTags sets the Tags field's value.

func (*CreateSceneInput) SetWorkspaceId

func (s *CreateSceneInput) SetWorkspaceId(v string) *CreateSceneInput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateSceneInput) String

func (s CreateSceneInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSceneInput) Validate

func (s *CreateSceneInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSceneOutput

type CreateSceneOutput struct {

	// The ARN of the scene.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the scene was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSceneOutput) GoString

func (s CreateSceneOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSceneOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateSceneOutput) SetCreationDateTime

func (s *CreateSceneOutput) SetCreationDateTime(v time.Time) *CreateSceneOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (CreateSceneOutput) String

func (s CreateSceneOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSyncJobInput added in v1.44.156

type CreateSyncJobInput struct {

	// The SyncJob IAM role. This IAM role is used by the SyncJob to read from the
	// syncSource, and create, update, or delete the corresponding resources.
	//
	// SyncRole is a required field
	SyncRole *string `locationName:"syncRole" min:"20" type:"string" required:"true"`

	// The sync source.
	//
	// Currently the only supported syncSoource is SITEWISE .
	//
	// SyncSource is a required field
	SyncSource *string `location:"uri" locationName:"syncSource" type:"string" required:"true"`

	// The SyncJob tags.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The workspace ID.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSyncJobInput) GoString added in v1.44.156

func (s CreateSyncJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSyncJobInput) SetSyncRole added in v1.44.156

func (s *CreateSyncJobInput) SetSyncRole(v string) *CreateSyncJobInput

SetSyncRole sets the SyncRole field's value.

func (*CreateSyncJobInput) SetSyncSource added in v1.44.156

func (s *CreateSyncJobInput) SetSyncSource(v string) *CreateSyncJobInput

SetSyncSource sets the SyncSource field's value.

func (*CreateSyncJobInput) SetTags added in v1.44.156

func (s *CreateSyncJobInput) SetTags(v map[string]*string) *CreateSyncJobInput

SetTags sets the Tags field's value.

func (*CreateSyncJobInput) SetWorkspaceId added in v1.44.156

func (s *CreateSyncJobInput) SetWorkspaceId(v string) *CreateSyncJobInput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateSyncJobInput) String added in v1.44.156

func (s CreateSyncJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSyncJobInput) Validate added in v1.44.156

func (s *CreateSyncJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSyncJobOutput added in v1.44.156

type CreateSyncJobOutput struct {

	// The SyncJob ARN.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time for the SyncJob creation.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The SyncJob response state.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"SyncJobState"`
	// contains filtered or unexported fields
}

func (CreateSyncJobOutput) GoString added in v1.44.156

func (s CreateSyncJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSyncJobOutput) SetArn added in v1.44.156

SetArn sets the Arn field's value.

func (*CreateSyncJobOutput) SetCreationDateTime added in v1.44.156

func (s *CreateSyncJobOutput) SetCreationDateTime(v time.Time) *CreateSyncJobOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*CreateSyncJobOutput) SetState added in v1.44.156

SetState sets the State field's value.

func (CreateSyncJobOutput) String added in v1.44.156

func (s CreateSyncJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspaceInput

type CreateWorkspaceInput struct {

	// The description of the workspace.
	Description *string `locationName:"description" type:"string"`

	// The ARN of the execution role associated with the workspace.
	//
	// Role is a required field
	Role *string `locationName:"role" min:"20" type:"string" required:"true"`

	// The ARN of the S3 bucket where resources associated with the workspace are
	// stored.
	//
	// S3Location is a required field
	S3Location *string `locationName:"s3Location" type:"string" required:"true"`

	// Metadata that you can use to manage the workspace
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceInput) GoString

func (s CreateWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceInput) SetDescription

func (s *CreateWorkspaceInput) SetDescription(v string) *CreateWorkspaceInput

SetDescription sets the Description field's value.

func (*CreateWorkspaceInput) SetRole

SetRole sets the Role field's value.

func (*CreateWorkspaceInput) SetS3Location

func (s *CreateWorkspaceInput) SetS3Location(v string) *CreateWorkspaceInput

SetS3Location sets the S3Location field's value.

func (*CreateWorkspaceInput) SetTags

SetTags sets the Tags field's value.

func (*CreateWorkspaceInput) SetWorkspaceId

func (s *CreateWorkspaceInput) SetWorkspaceId(v string) *CreateWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateWorkspaceInput) String

func (s CreateWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceInput) Validate

func (s *CreateWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkspaceOutput

type CreateWorkspaceOutput struct {

	// The ARN of the workspace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the workspace was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceOutput) GoString

func (s CreateWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateWorkspaceOutput) SetCreationDateTime

func (s *CreateWorkspaceOutput) SetCreationDateTime(v time.Time) *CreateWorkspaceOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (CreateWorkspaceOutput) String

func (s CreateWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataConnector

type DataConnector struct {

	// A Boolean value that specifies whether the data connector is native to IoT
	// TwinMaker.
	IsNative *bool `locationName:"isNative" type:"boolean"`

	// The Lambda function associated with this data connector.
	Lambda *LambdaFunction `locationName:"lambda" type:"structure"`
	// contains filtered or unexported fields
}

The data connector.

func (DataConnector) GoString

func (s DataConnector) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataConnector) SetIsNative

func (s *DataConnector) SetIsNative(v bool) *DataConnector

SetIsNative sets the IsNative field's value.

func (*DataConnector) SetLambda

func (s *DataConnector) SetLambda(v *LambdaFunction) *DataConnector

SetLambda sets the Lambda field's value.

func (DataConnector) String

func (s DataConnector) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataConnector) Validate

func (s *DataConnector) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataType

type DataType struct {

	// The allowed values for this data type.
	AllowedValues []*DataValue `locationName:"allowedValues" type:"list"`

	// The nested type in the data type.
	NestedType *DataType `locationName:"nestedType" type:"structure"`

	// A relationship that associates a component with another component.
	Relationship *Relationship `locationName:"relationship" type:"structure"`

	// The underlying type of the data type.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"Type"`

	// The unit of measure used in this data type.
	UnitOfMeasure *string `locationName:"unitOfMeasure" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that specifies the data type of a property.

func (DataType) GoString

func (s DataType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataType) SetAllowedValues

func (s *DataType) SetAllowedValues(v []*DataValue) *DataType

SetAllowedValues sets the AllowedValues field's value.

func (*DataType) SetNestedType

func (s *DataType) SetNestedType(v *DataType) *DataType

SetNestedType sets the NestedType field's value.

func (*DataType) SetRelationship

func (s *DataType) SetRelationship(v *Relationship) *DataType

SetRelationship sets the Relationship field's value.

func (*DataType) SetType

func (s *DataType) SetType(v string) *DataType

SetType sets the Type field's value.

func (*DataType) SetUnitOfMeasure

func (s *DataType) SetUnitOfMeasure(v string) *DataType

SetUnitOfMeasure sets the UnitOfMeasure field's value.

func (DataType) String

func (s DataType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataType) Validate

func (s *DataType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataValue

type DataValue struct {

	// A Boolean value.
	BooleanValue *bool `locationName:"booleanValue" type:"boolean"`

	// A double value.
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// An expression that produces the value.
	Expression *string `locationName:"expression" min:"1" type:"string"`

	// An integer value.
	IntegerValue *int64 `locationName:"integerValue" type:"integer"`

	// A list of multiple values.
	ListValue []*DataValue `locationName:"listValue" type:"list"`

	// A long value.
	LongValue *int64 `locationName:"longValue" type:"long"`

	// An object that maps strings to multiple DataValue objects.
	MapValue map[string]*DataValue `locationName:"mapValue" type:"map"`

	// A value that relates a component to another component.
	RelationshipValue *RelationshipValue `locationName:"relationshipValue" type:"structure"`

	// A string value.
	StringValue *string `locationName:"stringValue" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that specifies a value for a property.

func (DataValue) GoString

func (s DataValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataValue) SetBooleanValue

func (s *DataValue) SetBooleanValue(v bool) *DataValue

SetBooleanValue sets the BooleanValue field's value.

func (*DataValue) SetDoubleValue

func (s *DataValue) SetDoubleValue(v float64) *DataValue

SetDoubleValue sets the DoubleValue field's value.

func (*DataValue) SetExpression

func (s *DataValue) SetExpression(v string) *DataValue

SetExpression sets the Expression field's value.

func (*DataValue) SetIntegerValue

func (s *DataValue) SetIntegerValue(v int64) *DataValue

SetIntegerValue sets the IntegerValue field's value.

func (*DataValue) SetListValue

func (s *DataValue) SetListValue(v []*DataValue) *DataValue

SetListValue sets the ListValue field's value.

func (*DataValue) SetLongValue

func (s *DataValue) SetLongValue(v int64) *DataValue

SetLongValue sets the LongValue field's value.

func (*DataValue) SetMapValue

func (s *DataValue) SetMapValue(v map[string]*DataValue) *DataValue

SetMapValue sets the MapValue field's value.

func (*DataValue) SetRelationshipValue

func (s *DataValue) SetRelationshipValue(v *RelationshipValue) *DataValue

SetRelationshipValue sets the RelationshipValue field's value.

func (*DataValue) SetStringValue

func (s *DataValue) SetStringValue(v string) *DataValue

SetStringValue sets the StringValue field's value.

func (DataValue) String

func (s DataValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataValue) Validate

func (s *DataValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteComponentTypeInput

type DeleteComponentTypeInput struct {

	// The ID of the component type to delete.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `location:"uri" locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// The ID of the workspace that contains the component type.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteComponentTypeInput) GoString

func (s DeleteComponentTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentTypeInput) SetComponentTypeId

func (s *DeleteComponentTypeInput) SetComponentTypeId(v string) *DeleteComponentTypeInput

SetComponentTypeId sets the ComponentTypeId field's value.

func (*DeleteComponentTypeInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteComponentTypeInput) String

func (s DeleteComponentTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentTypeInput) Validate

func (s *DeleteComponentTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteComponentTypeOutput

type DeleteComponentTypeOutput struct {

	// The current state of the component type to be deleted.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`
	// contains filtered or unexported fields
}

func (DeleteComponentTypeOutput) GoString

func (s DeleteComponentTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentTypeOutput) SetState

SetState sets the State field's value.

func (DeleteComponentTypeOutput) String

func (s DeleteComponentTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEntityInput

type DeleteEntityInput struct {

	// The ID of the entity to delete.
	//
	// EntityId is a required field
	EntityId *string `location:"uri" locationName:"entityId" min:"1" type:"string" required:"true"`

	// A Boolean value that specifies whether the operation deletes child entities.
	IsRecursive *bool `location:"querystring" locationName:"isRecursive" type:"boolean"`

	// The ID of the workspace that contains the entity to delete.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEntityInput) GoString

func (s DeleteEntityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEntityInput) SetEntityId

func (s *DeleteEntityInput) SetEntityId(v string) *DeleteEntityInput

SetEntityId sets the EntityId field's value.

func (*DeleteEntityInput) SetIsRecursive

func (s *DeleteEntityInput) SetIsRecursive(v bool) *DeleteEntityInput

SetIsRecursive sets the IsRecursive field's value.

func (*DeleteEntityInput) SetWorkspaceId

func (s *DeleteEntityInput) SetWorkspaceId(v string) *DeleteEntityInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteEntityInput) String

func (s DeleteEntityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEntityInput) Validate

func (s *DeleteEntityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEntityOutput

type DeleteEntityOutput struct {

	// The current state of the deleted entity.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`
	// contains filtered or unexported fields
}

func (DeleteEntityOutput) GoString

func (s DeleteEntityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEntityOutput) SetState

SetState sets the State field's value.

func (DeleteEntityOutput) String

func (s DeleteEntityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSceneInput

type DeleteSceneInput struct {

	// The ID of the scene to delete.
	//
	// SceneId is a required field
	SceneId *string `location:"uri" locationName:"sceneId" min:"1" type:"string" required:"true"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSceneInput) GoString

func (s DeleteSceneInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSceneInput) SetSceneId

func (s *DeleteSceneInput) SetSceneId(v string) *DeleteSceneInput

SetSceneId sets the SceneId field's value.

func (*DeleteSceneInput) SetWorkspaceId

func (s *DeleteSceneInput) SetWorkspaceId(v string) *DeleteSceneInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteSceneInput) String

func (s DeleteSceneInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSceneInput) Validate

func (s *DeleteSceneInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSceneOutput

type DeleteSceneOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSceneOutput) GoString

func (s DeleteSceneOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSceneOutput) String

func (s DeleteSceneOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSyncJobInput added in v1.44.156

type DeleteSyncJobInput struct {

	// The sync source.
	//
	// Currently the only supported syncSource is SITEWISE .
	//
	// SyncSource is a required field
	SyncSource *string `location:"uri" locationName:"syncSource" type:"string" required:"true"`

	// The workspace ID.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSyncJobInput) GoString added in v1.44.156

func (s DeleteSyncJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSyncJobInput) SetSyncSource added in v1.44.156

func (s *DeleteSyncJobInput) SetSyncSource(v string) *DeleteSyncJobInput

SetSyncSource sets the SyncSource field's value.

func (*DeleteSyncJobInput) SetWorkspaceId added in v1.44.156

func (s *DeleteSyncJobInput) SetWorkspaceId(v string) *DeleteSyncJobInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteSyncJobInput) String added in v1.44.156

func (s DeleteSyncJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSyncJobInput) Validate added in v1.44.156

func (s *DeleteSyncJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSyncJobOutput added in v1.44.156

type DeleteSyncJobOutput struct {

	// The SyncJob response state.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"SyncJobState"`
	// contains filtered or unexported fields
}

func (DeleteSyncJobOutput) GoString added in v1.44.156

func (s DeleteSyncJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSyncJobOutput) SetState added in v1.44.156

SetState sets the State field's value.

func (DeleteSyncJobOutput) String added in v1.44.156

func (s DeleteSyncJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceInput

type DeleteWorkspaceInput struct {

	// The ID of the workspace to delete.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkspaceInput) GoString

func (s DeleteWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceInput) SetWorkspaceId

func (s *DeleteWorkspaceInput) SetWorkspaceId(v string) *DeleteWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteWorkspaceInput) String

func (s DeleteWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceInput) Validate

func (s *DeleteWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkspaceOutput

type DeleteWorkspaceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteWorkspaceOutput) GoString

func (s DeleteWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkspaceOutput) String

func (s DeleteWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EntityPropertyReference

type EntityPropertyReference struct {

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The ID of the entity.
	EntityId *string `locationName:"entityId" min:"1" type:"string"`

	// A mapping of external IDs to property names. External IDs uniquely identify
	// properties from external data stores.
	ExternalIdProperty map[string]*string `locationName:"externalIdProperty" type:"map"`

	// The name of the property.
	//
	// PropertyName is a required field
	PropertyName *string `locationName:"propertyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that uniquely identifies an entity property.

func (EntityPropertyReference) GoString

func (s EntityPropertyReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityPropertyReference) SetComponentName

func (s *EntityPropertyReference) SetComponentName(v string) *EntityPropertyReference

SetComponentName sets the ComponentName field's value.

func (*EntityPropertyReference) SetEntityId

SetEntityId sets the EntityId field's value.

func (*EntityPropertyReference) SetExternalIdProperty

func (s *EntityPropertyReference) SetExternalIdProperty(v map[string]*string) *EntityPropertyReference

SetExternalIdProperty sets the ExternalIdProperty field's value.

func (*EntityPropertyReference) SetPropertyName

SetPropertyName sets the PropertyName field's value.

func (EntityPropertyReference) String

func (s EntityPropertyReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityPropertyReference) Validate

func (s *EntityPropertyReference) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntitySummary

type EntitySummary struct {

	// The ARN of the entity.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the entity was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the entity.
	Description *string `locationName:"description" type:"string"`

	// The ID of the entity.
	//
	// EntityId is a required field
	EntityId *string `locationName:"entityId" min:"1" type:"string" required:"true"`

	// The name of the entity.
	//
	// EntityName is a required field
	EntityName *string `locationName:"entityName" min:"1" type:"string" required:"true"`

	// A Boolean value that specifies whether the entity has child entities or not.
	HasChildEntities *bool `locationName:"hasChildEntities" type:"boolean"`

	// The ID of the parent entity.
	ParentEntityId *string `locationName:"parentEntityId" min:"1" type:"string"`

	// The current status of the entity.
	//
	// Status is a required field
	Status *Status `locationName:"status" type:"structure" required:"true"`

	// The last date and time when the entity was updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about an entity.

func (EntitySummary) GoString

func (s EntitySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntitySummary) SetArn

func (s *EntitySummary) SetArn(v string) *EntitySummary

SetArn sets the Arn field's value.

func (*EntitySummary) SetCreationDateTime

func (s *EntitySummary) SetCreationDateTime(v time.Time) *EntitySummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*EntitySummary) SetDescription

func (s *EntitySummary) SetDescription(v string) *EntitySummary

SetDescription sets the Description field's value.

func (*EntitySummary) SetEntityId

func (s *EntitySummary) SetEntityId(v string) *EntitySummary

SetEntityId sets the EntityId field's value.

func (*EntitySummary) SetEntityName

func (s *EntitySummary) SetEntityName(v string) *EntitySummary

SetEntityName sets the EntityName field's value.

func (*EntitySummary) SetHasChildEntities

func (s *EntitySummary) SetHasChildEntities(v bool) *EntitySummary

SetHasChildEntities sets the HasChildEntities field's value.

func (*EntitySummary) SetParentEntityId

func (s *EntitySummary) SetParentEntityId(v string) *EntitySummary

SetParentEntityId sets the ParentEntityId field's value.

func (*EntitySummary) SetStatus

func (s *EntitySummary) SetStatus(v *Status) *EntitySummary

SetStatus sets the Status field's value.

func (*EntitySummary) SetUpdateDateTime

func (s *EntitySummary) SetUpdateDateTime(v time.Time) *EntitySummary

SetUpdateDateTime sets the UpdateDateTime field's value.

func (EntitySummary) String

func (s EntitySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ErrorDetails

type ErrorDetails struct {

	// The error code.
	Code *string `locationName:"code" type:"string" enum:"ErrorCode"`

	// The error message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The error details.

func (ErrorDetails) GoString

func (s ErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorDetails) SetCode

func (s *ErrorDetails) SetCode(v string) *ErrorDetails

SetCode sets the Code field's value.

func (*ErrorDetails) SetMessage

func (s *ErrorDetails) SetMessage(v string) *ErrorDetails

SetMessage sets the Message field's value.

func (ErrorDetails) String

func (s ErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecuteQueryInput added in v1.44.139

type ExecuteQueryInput struct {

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The query statement.
	//
	// QueryStatement is a required field
	QueryStatement *string `locationName:"queryStatement" min:"1" type:"string" required:"true"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteQueryInput) GoString added in v1.44.139

func (s ExecuteQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteQueryInput) SetMaxResults added in v1.44.139

func (s *ExecuteQueryInput) SetMaxResults(v int64) *ExecuteQueryInput

SetMaxResults sets the MaxResults field's value.

func (*ExecuteQueryInput) SetNextToken added in v1.44.139

func (s *ExecuteQueryInput) SetNextToken(v string) *ExecuteQueryInput

SetNextToken sets the NextToken field's value.

func (*ExecuteQueryInput) SetQueryStatement added in v1.44.139

func (s *ExecuteQueryInput) SetQueryStatement(v string) *ExecuteQueryInput

SetQueryStatement sets the QueryStatement field's value.

func (*ExecuteQueryInput) SetWorkspaceId added in v1.44.139

func (s *ExecuteQueryInput) SetWorkspaceId(v string) *ExecuteQueryInput

SetWorkspaceId sets the WorkspaceId field's value.

func (ExecuteQueryInput) String added in v1.44.139

func (s ExecuteQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteQueryInput) Validate added in v1.44.139

func (s *ExecuteQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExecuteQueryOutput added in v1.44.139

type ExecuteQueryOutput struct {

	// A list of ColumnDescription objects.
	ColumnDescriptions []*ColumnDescription `locationName:"columnDescriptions" type:"list"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Represents a single row in the query results.
	Rows []*Row `locationName:"rows" type:"list"`
	// contains filtered or unexported fields
}

func (ExecuteQueryOutput) GoString added in v1.44.139

func (s ExecuteQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteQueryOutput) SetColumnDescriptions added in v1.44.139

func (s *ExecuteQueryOutput) SetColumnDescriptions(v []*ColumnDescription) *ExecuteQueryOutput

SetColumnDescriptions sets the ColumnDescriptions field's value.

func (*ExecuteQueryOutput) SetNextToken added in v1.44.139

func (s *ExecuteQueryOutput) SetNextToken(v string) *ExecuteQueryOutput

SetNextToken sets the NextToken field's value.

func (*ExecuteQueryOutput) SetRows added in v1.44.139

func (s *ExecuteQueryOutput) SetRows(v []*Row) *ExecuteQueryOutput

SetRows sets the Rows field's value.

func (ExecuteQueryOutput) String added in v1.44.139

func (s ExecuteQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FunctionRequest

type FunctionRequest struct {

	// The data connector.
	ImplementedBy *DataConnector `locationName:"implementedBy" type:"structure"`

	// The required properties of the function.
	RequiredProperties []*string `locationName:"requiredProperties" type:"list"`

	// The scope of the function.
	Scope *string `locationName:"scope" type:"string" enum:"Scope"`
	// contains filtered or unexported fields
}

The function request body.

func (FunctionRequest) GoString

func (s FunctionRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionRequest) SetImplementedBy

func (s *FunctionRequest) SetImplementedBy(v *DataConnector) *FunctionRequest

SetImplementedBy sets the ImplementedBy field's value.

func (*FunctionRequest) SetRequiredProperties

func (s *FunctionRequest) SetRequiredProperties(v []*string) *FunctionRequest

SetRequiredProperties sets the RequiredProperties field's value.

func (*FunctionRequest) SetScope

func (s *FunctionRequest) SetScope(v string) *FunctionRequest

SetScope sets the Scope field's value.

func (FunctionRequest) String

func (s FunctionRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionRequest) Validate

func (s *FunctionRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FunctionResponse

type FunctionResponse struct {

	// The data connector.
	ImplementedBy *DataConnector `locationName:"implementedBy" type:"structure"`

	// Indicates whether this function is inherited.
	IsInherited *bool `locationName:"isInherited" type:"boolean"`

	// The required properties of the function.
	RequiredProperties []*string `locationName:"requiredProperties" type:"list"`

	// The scope of the function.
	Scope *string `locationName:"scope" type:"string" enum:"Scope"`
	// contains filtered or unexported fields
}

The function response.

func (FunctionResponse) GoString

func (s FunctionResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionResponse) SetImplementedBy

func (s *FunctionResponse) SetImplementedBy(v *DataConnector) *FunctionResponse

SetImplementedBy sets the ImplementedBy field's value.

func (*FunctionResponse) SetIsInherited

func (s *FunctionResponse) SetIsInherited(v bool) *FunctionResponse

SetIsInherited sets the IsInherited field's value.

func (*FunctionResponse) SetRequiredProperties

func (s *FunctionResponse) SetRequiredProperties(v []*string) *FunctionResponse

SetRequiredProperties sets the RequiredProperties field's value.

func (*FunctionResponse) SetScope

func (s *FunctionResponse) SetScope(v string) *FunctionResponse

SetScope sets the Scope field's value.

func (FunctionResponse) String

func (s FunctionResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetComponentTypeInput

type GetComponentTypeInput struct {

	// The ID of the component type.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `location:"uri" locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// The ID of the workspace that contains the component type.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComponentTypeInput) GoString

func (s GetComponentTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentTypeInput) SetComponentTypeId

func (s *GetComponentTypeInput) SetComponentTypeId(v string) *GetComponentTypeInput

SetComponentTypeId sets the ComponentTypeId field's value.

func (*GetComponentTypeInput) SetWorkspaceId

func (s *GetComponentTypeInput) SetWorkspaceId(v string) *GetComponentTypeInput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetComponentTypeInput) String

func (s GetComponentTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentTypeInput) Validate

func (s *GetComponentTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetComponentTypeOutput

type GetComponentTypeOutput struct {

	// The ARN of the component type.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The ID of the component type.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// The component type name.
	ComponentTypeName *string `locationName:"componentTypeName" type:"string"`

	// The date and time when the component type was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the component type.
	Description *string `locationName:"description" type:"string"`

	// The name of the parent component type that this component type extends.
	ExtendsFrom []*string `locationName:"extendsFrom" type:"list"`

	// An object that maps strings to the functions in the component type. Each
	// string in the mapping must be unique to this object.
	Functions map[string]*FunctionResponse `locationName:"functions" type:"map"`

	// A Boolean value that specifies whether the component type is abstract.
	IsAbstract *bool `locationName:"isAbstract" type:"boolean"`

	// A Boolean value that specifies whether the component type has a schema initializer
	// and that the schema initializer has run.
	IsSchemaInitialized *bool `locationName:"isSchemaInitialized" type:"boolean"`

	// A Boolean value that specifies whether an entity can have more than one component
	// of this type.
	IsSingleton *bool `locationName:"isSingleton" type:"boolean"`

	// An object that maps strings to the property definitions in the component
	// type. Each string in the mapping must be unique to this object.
	PropertyDefinitions map[string]*PropertyDefinitionResponse `locationName:"propertyDefinitions" type:"map"`

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	PropertyGroups map[string]*PropertyGroupResponse `locationName:"propertyGroups" type:"map"`

	// The current status of the component type.
	Status *Status `locationName:"status" type:"structure"`

	// The syncSource of the SyncJob, if this entity was created by a SyncJob.
	SyncSource *string `locationName:"syncSource" type:"string"`

	// The date and time when the component was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The ID of the workspace that contains the component type.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComponentTypeOutput) GoString

func (s GetComponentTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentTypeOutput) SetArn

SetArn sets the Arn field's value.

func (*GetComponentTypeOutput) SetComponentTypeId

func (s *GetComponentTypeOutput) SetComponentTypeId(v string) *GetComponentTypeOutput

SetComponentTypeId sets the ComponentTypeId field's value.

func (*GetComponentTypeOutput) SetComponentTypeName added in v1.44.156

func (s *GetComponentTypeOutput) SetComponentTypeName(v string) *GetComponentTypeOutput

SetComponentTypeName sets the ComponentTypeName field's value.

func (*GetComponentTypeOutput) SetCreationDateTime

func (s *GetComponentTypeOutput) SetCreationDateTime(v time.Time) *GetComponentTypeOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*GetComponentTypeOutput) SetDescription

SetDescription sets the Description field's value.

func (*GetComponentTypeOutput) SetExtendsFrom

func (s *GetComponentTypeOutput) SetExtendsFrom(v []*string) *GetComponentTypeOutput

SetExtendsFrom sets the ExtendsFrom field's value.

func (*GetComponentTypeOutput) SetFunctions

SetFunctions sets the Functions field's value.

func (*GetComponentTypeOutput) SetIsAbstract

func (s *GetComponentTypeOutput) SetIsAbstract(v bool) *GetComponentTypeOutput

SetIsAbstract sets the IsAbstract field's value.

func (*GetComponentTypeOutput) SetIsSchemaInitialized

func (s *GetComponentTypeOutput) SetIsSchemaInitialized(v bool) *GetComponentTypeOutput

SetIsSchemaInitialized sets the IsSchemaInitialized field's value.

func (*GetComponentTypeOutput) SetIsSingleton

func (s *GetComponentTypeOutput) SetIsSingleton(v bool) *GetComponentTypeOutput

SetIsSingleton sets the IsSingleton field's value.

func (*GetComponentTypeOutput) SetPropertyDefinitions

SetPropertyDefinitions sets the PropertyDefinitions field's value.

func (*GetComponentTypeOutput) SetPropertyGroups added in v1.44.139

SetPropertyGroups sets the PropertyGroups field's value.

func (*GetComponentTypeOutput) SetStatus

SetStatus sets the Status field's value.

func (*GetComponentTypeOutput) SetSyncSource added in v1.44.156

SetSyncSource sets the SyncSource field's value.

func (*GetComponentTypeOutput) SetUpdateDateTime

func (s *GetComponentTypeOutput) SetUpdateDateTime(v time.Time) *GetComponentTypeOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*GetComponentTypeOutput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (GetComponentTypeOutput) String

func (s GetComponentTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetEntityInput

type GetEntityInput struct {

	// The ID of the entity.
	//
	// EntityId is a required field
	EntityId *string `location:"uri" locationName:"entityId" min:"1" type:"string" required:"true"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEntityInput) GoString

func (s GetEntityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEntityInput) SetEntityId

func (s *GetEntityInput) SetEntityId(v string) *GetEntityInput

SetEntityId sets the EntityId field's value.

func (*GetEntityInput) SetWorkspaceId

func (s *GetEntityInput) SetWorkspaceId(v string) *GetEntityInput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetEntityInput) String

func (s GetEntityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEntityInput) Validate

func (s *GetEntityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEntityOutput

type GetEntityOutput struct {

	// The ARN of the entity.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// An object that maps strings to the components in the entity. Each string
	// in the mapping must be unique to this object.
	Components map[string]*ComponentResponse `locationName:"components" type:"map"`

	// The date and time when the entity was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the entity.
	Description *string `locationName:"description" type:"string"`

	// The ID of the entity.
	//
	// EntityId is a required field
	EntityId *string `locationName:"entityId" min:"1" type:"string" required:"true"`

	// The name of the entity.
	//
	// EntityName is a required field
	EntityName *string `locationName:"entityName" min:"1" type:"string" required:"true"`

	// A Boolean value that specifies whether the entity has associated child entities.
	//
	// HasChildEntities is a required field
	HasChildEntities *bool `locationName:"hasChildEntities" type:"boolean" required:"true"`

	// The ID of the parent entity for this entity.
	//
	// ParentEntityId is a required field
	ParentEntityId *string `locationName:"parentEntityId" min:"1" type:"string" required:"true"`

	// The current status of the entity.
	//
	// Status is a required field
	Status *Status `locationName:"status" type:"structure" required:"true"`

	// The syncSource of the sync job, if this entity was created by a sync job.
	SyncSource *string `locationName:"syncSource" type:"string"`

	// The date and time when the entity was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEntityOutput) GoString

func (s GetEntityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEntityOutput) SetArn

func (s *GetEntityOutput) SetArn(v string) *GetEntityOutput

SetArn sets the Arn field's value.

func (*GetEntityOutput) SetComponents

func (s *GetEntityOutput) SetComponents(v map[string]*ComponentResponse) *GetEntityOutput

SetComponents sets the Components field's value.

func (*GetEntityOutput) SetCreationDateTime

func (s *GetEntityOutput) SetCreationDateTime(v time.Time) *GetEntityOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*GetEntityOutput) SetDescription

func (s *GetEntityOutput) SetDescription(v string) *GetEntityOutput

SetDescription sets the Description field's value.

func (*GetEntityOutput) SetEntityId

func (s *GetEntityOutput) SetEntityId(v string) *GetEntityOutput

SetEntityId sets the EntityId field's value.

func (*GetEntityOutput) SetEntityName

func (s *GetEntityOutput) SetEntityName(v string) *GetEntityOutput

SetEntityName sets the EntityName field's value.

func (*GetEntityOutput) SetHasChildEntities

func (s *GetEntityOutput) SetHasChildEntities(v bool) *GetEntityOutput

SetHasChildEntities sets the HasChildEntities field's value.

func (*GetEntityOutput) SetParentEntityId

func (s *GetEntityOutput) SetParentEntityId(v string) *GetEntityOutput

SetParentEntityId sets the ParentEntityId field's value.

func (*GetEntityOutput) SetStatus

func (s *GetEntityOutput) SetStatus(v *Status) *GetEntityOutput

SetStatus sets the Status field's value.

func (*GetEntityOutput) SetSyncSource added in v1.44.156

func (s *GetEntityOutput) SetSyncSource(v string) *GetEntityOutput

SetSyncSource sets the SyncSource field's value.

func (*GetEntityOutput) SetUpdateDateTime

func (s *GetEntityOutput) SetUpdateDateTime(v time.Time) *GetEntityOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*GetEntityOutput) SetWorkspaceId

func (s *GetEntityOutput) SetWorkspaceId(v string) *GetEntityOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetEntityOutput) String

func (s GetEntityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPricingPlanInput added in v1.44.139

type GetPricingPlanInput struct {
	// contains filtered or unexported fields
}

func (GetPricingPlanInput) GoString added in v1.44.139

func (s GetPricingPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetPricingPlanInput) String added in v1.44.139

func (s GetPricingPlanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPricingPlanOutput added in v1.44.139

type GetPricingPlanOutput struct {

	// The chosen pricing plan for the current billing cycle.
	//
	// CurrentPricingPlan is a required field
	CurrentPricingPlan *PricingPlan `locationName:"currentPricingPlan" type:"structure" required:"true"`

	// The pending pricing plan.
	PendingPricingPlan *PricingPlan `locationName:"pendingPricingPlan" type:"structure"`
	// contains filtered or unexported fields
}

func (GetPricingPlanOutput) GoString added in v1.44.139

func (s GetPricingPlanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPricingPlanOutput) SetCurrentPricingPlan added in v1.44.139

func (s *GetPricingPlanOutput) SetCurrentPricingPlan(v *PricingPlan) *GetPricingPlanOutput

SetCurrentPricingPlan sets the CurrentPricingPlan field's value.

func (*GetPricingPlanOutput) SetPendingPricingPlan added in v1.44.139

func (s *GetPricingPlanOutput) SetPendingPricingPlan(v *PricingPlan) *GetPricingPlanOutput

SetPendingPricingPlan sets the PendingPricingPlan field's value.

func (GetPricingPlanOutput) String added in v1.44.139

func (s GetPricingPlanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPropertyValueHistoryInput

type GetPropertyValueHistoryInput struct {

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The ID of the component type.
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string"`

	// The date and time of the latest property value to return.
	//
	// Deprecated: This field is deprecated and will throw an error in the future. Use endTime instead.
	EndDateTime *time.Time `locationName:"endDateTime" deprecated:"true" type:"timestamp"`

	// The ISO8601 DateTime of the latest property value to return.
	//
	// For more information about the ISO8601 DateTime format, see the data type
	// PropertyValue (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html).
	EndTime *string `locationName:"endTime" min:"20" type:"string"`

	// The ID of the entity.
	EntityId *string `locationName:"entityId" min:"1" type:"string"`

	// An object that specifies the interpolation type and the interval over which
	// to interpolate data.
	Interpolation *InterpolationParameters `locationName:"interpolation" type:"structure"`

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The time direction to use in the result order.
	OrderByTime *string `locationName:"orderByTime" type:"string" enum:"OrderByTime"`

	// A list of objects that filter the property value history request.
	PropertyFilters []*PropertyFilter `locationName:"propertyFilters" min:"1" type:"list"`

	// A list of properties whose value histories the request retrieves.
	//
	// SelectedProperties is a required field
	SelectedProperties []*string `locationName:"selectedProperties" min:"1" type:"list" required:"true"`

	// The date and time of the earliest property value to return.
	//
	// Deprecated: This field is deprecated and will throw an error in the future. Use startTime instead.
	StartDateTime *time.Time `locationName:"startDateTime" deprecated:"true" type:"timestamp"`

	// The ISO8601 DateTime of the earliest property value to return.
	//
	// For more information about the ISO8601 DateTime format, see the data type
	// PropertyValue (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html).
	StartTime *string `locationName:"startTime" min:"20" type:"string"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPropertyValueHistoryInput) GoString

func (s GetPropertyValueHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPropertyValueHistoryInput) SetComponentName

SetComponentName sets the ComponentName field's value.

func (*GetPropertyValueHistoryInput) SetComponentTypeId

SetComponentTypeId sets the ComponentTypeId field's value.

func (*GetPropertyValueHistoryInput) SetEndDateTime

SetEndDateTime sets the EndDateTime field's value.

func (*GetPropertyValueHistoryInput) SetEndTime added in v1.43.38

SetEndTime sets the EndTime field's value.

func (*GetPropertyValueHistoryInput) SetEntityId

SetEntityId sets the EntityId field's value.

func (*GetPropertyValueHistoryInput) SetInterpolation

SetInterpolation sets the Interpolation field's value.

func (*GetPropertyValueHistoryInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*GetPropertyValueHistoryInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetPropertyValueHistoryInput) SetOrderByTime

SetOrderByTime sets the OrderByTime field's value.

func (*GetPropertyValueHistoryInput) SetPropertyFilters

SetPropertyFilters sets the PropertyFilters field's value.

func (*GetPropertyValueHistoryInput) SetSelectedProperties

func (s *GetPropertyValueHistoryInput) SetSelectedProperties(v []*string) *GetPropertyValueHistoryInput

SetSelectedProperties sets the SelectedProperties field's value.

func (*GetPropertyValueHistoryInput) SetStartDateTime

SetStartDateTime sets the StartDateTime field's value.

func (*GetPropertyValueHistoryInput) SetStartTime added in v1.43.38

SetStartTime sets the StartTime field's value.

func (*GetPropertyValueHistoryInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (GetPropertyValueHistoryInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPropertyValueHistoryInput) Validate

func (s *GetPropertyValueHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPropertyValueHistoryOutput

type GetPropertyValueHistoryOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An object that maps strings to the property definitions in the component
	// type. Each string in the mapping must be unique to this object.
	//
	// PropertyValues is a required field
	PropertyValues []*PropertyValueHistory `locationName:"propertyValues" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetPropertyValueHistoryOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPropertyValueHistoryOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetPropertyValueHistoryOutput) SetPropertyValues

SetPropertyValues sets the PropertyValues field's value.

func (GetPropertyValueHistoryOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPropertyValueInput

type GetPropertyValueInput struct {

	// The name of the component whose property values the operation returns.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The ID of the component type whose property values the operation returns.
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string"`

	// The ID of the entity whose property values the operation returns.
	EntityId *string `locationName:"entityId" min:"1" type:"string"`

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The property group name.
	PropertyGroupName *string `locationName:"propertyGroupName" min:"1" type:"string"`

	// The properties whose values the operation returns.
	//
	// SelectedProperties is a required field
	SelectedProperties []*string `locationName:"selectedProperties" min:"1" type:"list" required:"true"`

	// The tabular conditions.
	TabularConditions *TabularConditions `locationName:"tabularConditions" type:"structure"`

	// The ID of the workspace whose values the operation returns.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPropertyValueInput) GoString

func (s GetPropertyValueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPropertyValueInput) SetComponentName

func (s *GetPropertyValueInput) SetComponentName(v string) *GetPropertyValueInput

SetComponentName sets the ComponentName field's value.

func (*GetPropertyValueInput) SetComponentTypeId

func (s *GetPropertyValueInput) SetComponentTypeId(v string) *GetPropertyValueInput

SetComponentTypeId sets the ComponentTypeId field's value.

func (*GetPropertyValueInput) SetEntityId

SetEntityId sets the EntityId field's value.

func (*GetPropertyValueInput) SetMaxResults added in v1.44.139

func (s *GetPropertyValueInput) SetMaxResults(v int64) *GetPropertyValueInput

SetMaxResults sets the MaxResults field's value.

func (*GetPropertyValueInput) SetNextToken added in v1.44.139

SetNextToken sets the NextToken field's value.

func (*GetPropertyValueInput) SetPropertyGroupName added in v1.44.139

func (s *GetPropertyValueInput) SetPropertyGroupName(v string) *GetPropertyValueInput

SetPropertyGroupName sets the PropertyGroupName field's value.

func (*GetPropertyValueInput) SetSelectedProperties

func (s *GetPropertyValueInput) SetSelectedProperties(v []*string) *GetPropertyValueInput

SetSelectedProperties sets the SelectedProperties field's value.

func (*GetPropertyValueInput) SetTabularConditions added in v1.44.139

func (s *GetPropertyValueInput) SetTabularConditions(v *TabularConditions) *GetPropertyValueInput

SetTabularConditions sets the TabularConditions field's value.

func (*GetPropertyValueInput) SetWorkspaceId

func (s *GetPropertyValueInput) SetWorkspaceId(v string) *GetPropertyValueInput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetPropertyValueInput) String

func (s GetPropertyValueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPropertyValueInput) Validate

func (s *GetPropertyValueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPropertyValueOutput

type GetPropertyValueOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An object that maps strings to the properties and latest property values
	// in the response. Each string in the mapping must be unique to this object.
	PropertyValues map[string]*PropertyLatestValue `locationName:"propertyValues" type:"map"`

	// A table of property values.
	TabularPropertyValues [][]map[string]*DataValue `locationName:"tabularPropertyValues" type:"list"`
	// contains filtered or unexported fields
}

func (GetPropertyValueOutput) GoString

func (s GetPropertyValueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPropertyValueOutput) SetNextToken added in v1.44.139

SetNextToken sets the NextToken field's value.

func (*GetPropertyValueOutput) SetPropertyValues

SetPropertyValues sets the PropertyValues field's value.

func (*GetPropertyValueOutput) SetTabularPropertyValues added in v1.44.139

func (s *GetPropertyValueOutput) SetTabularPropertyValues(v [][]map[string]*DataValue) *GetPropertyValueOutput

SetTabularPropertyValues sets the TabularPropertyValues field's value.

func (GetPropertyValueOutput) String

func (s GetPropertyValueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSceneInput

type GetSceneInput struct {

	// The ID of the scene.
	//
	// SceneId is a required field
	SceneId *string `location:"uri" locationName:"sceneId" min:"1" type:"string" required:"true"`

	// The ID of the workspace that contains the scene.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSceneInput) GoString

func (s GetSceneInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSceneInput) SetSceneId

func (s *GetSceneInput) SetSceneId(v string) *GetSceneInput

SetSceneId sets the SceneId field's value.

func (*GetSceneInput) SetWorkspaceId

func (s *GetSceneInput) SetWorkspaceId(v string) *GetSceneInput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetSceneInput) String

func (s GetSceneInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSceneInput) Validate

func (s *GetSceneInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSceneOutput

type GetSceneOutput struct {

	// The ARN of the scene.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// A list of capabilities that the scene uses to render.
	Capabilities []*string `locationName:"capabilities" type:"list"`

	// The relative path that specifies the location of the content definition file.
	//
	// ContentLocation is a required field
	ContentLocation *string `locationName:"contentLocation" type:"string" required:"true"`

	// The date and time when the scene was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the scene.
	Description *string `locationName:"description" type:"string"`

	// The SceneResponse error.
	Error *SceneError `locationName:"error" type:"structure"`

	// The generated scene metadata.
	GeneratedSceneMetadata map[string]*string `locationName:"generatedSceneMetadata" type:"map"`

	// The ID of the scene.
	//
	// SceneId is a required field
	SceneId *string `locationName:"sceneId" min:"1" type:"string" required:"true"`

	// The response metadata.
	SceneMetadata map[string]*string `locationName:"sceneMetadata" type:"map"`

	// The date and time when the scene was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The ID of the workspace that contains the scene.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSceneOutput) GoString

func (s GetSceneOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSceneOutput) SetArn

func (s *GetSceneOutput) SetArn(v string) *GetSceneOutput

SetArn sets the Arn field's value.

func (*GetSceneOutput) SetCapabilities

func (s *GetSceneOutput) SetCapabilities(v []*string) *GetSceneOutput

SetCapabilities sets the Capabilities field's value.

func (*GetSceneOutput) SetContentLocation

func (s *GetSceneOutput) SetContentLocation(v string) *GetSceneOutput

SetContentLocation sets the ContentLocation field's value.

func (*GetSceneOutput) SetCreationDateTime

func (s *GetSceneOutput) SetCreationDateTime(v time.Time) *GetSceneOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*GetSceneOutput) SetDescription

func (s *GetSceneOutput) SetDescription(v string) *GetSceneOutput

SetDescription sets the Description field's value.

func (*GetSceneOutput) SetError added in v1.44.256

func (s *GetSceneOutput) SetError(v *SceneError) *GetSceneOutput

SetError sets the Error field's value.

func (*GetSceneOutput) SetGeneratedSceneMetadata added in v1.44.227

func (s *GetSceneOutput) SetGeneratedSceneMetadata(v map[string]*string) *GetSceneOutput

SetGeneratedSceneMetadata sets the GeneratedSceneMetadata field's value.

func (*GetSceneOutput) SetSceneId

func (s *GetSceneOutput) SetSceneId(v string) *GetSceneOutput

SetSceneId sets the SceneId field's value.

func (*GetSceneOutput) SetSceneMetadata added in v1.44.227

func (s *GetSceneOutput) SetSceneMetadata(v map[string]*string) *GetSceneOutput

SetSceneMetadata sets the SceneMetadata field's value.

func (*GetSceneOutput) SetUpdateDateTime

func (s *GetSceneOutput) SetUpdateDateTime(v time.Time) *GetSceneOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*GetSceneOutput) SetWorkspaceId

func (s *GetSceneOutput) SetWorkspaceId(v string) *GetSceneOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetSceneOutput) String

func (s GetSceneOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSyncJobInput added in v1.44.156

type GetSyncJobInput struct {

	// The sync source.
	//
	// Currently the only supported syncSource is SITEWISE .
	//
	// SyncSource is a required field
	SyncSource *string `location:"uri" locationName:"syncSource" type:"string" required:"true"`

	// The workspace ID.
	WorkspaceId *string `location:"querystring" locationName:"workspace" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetSyncJobInput) GoString added in v1.44.156

func (s GetSyncJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSyncJobInput) SetSyncSource added in v1.44.156

func (s *GetSyncJobInput) SetSyncSource(v string) *GetSyncJobInput

SetSyncSource sets the SyncSource field's value.

func (*GetSyncJobInput) SetWorkspaceId added in v1.44.156

func (s *GetSyncJobInput) SetWorkspaceId(v string) *GetSyncJobInput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetSyncJobInput) String added in v1.44.156

func (s GetSyncJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSyncJobInput) Validate added in v1.44.156

func (s *GetSyncJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSyncJobOutput added in v1.44.156

type GetSyncJobOutput struct {

	// The sync job ARN.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The creation date and time.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The SyncJob response status.
	//
	// Status is a required field
	Status *SyncJobStatus `locationName:"status" type:"structure" required:"true"`

	// The sync IAM role.
	//
	// SyncRole is a required field
	SyncRole *string `locationName:"syncRole" min:"20" type:"string" required:"true"`

	// The sync soucre.
	//
	// Currently the only supported syncSource is SITEWISE .
	//
	// SyncSource is a required field
	SyncSource *string `locationName:"syncSource" type:"string" required:"true"`

	// The update date and time.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The ID of the workspace that contains the sync job.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSyncJobOutput) GoString added in v1.44.156

func (s GetSyncJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSyncJobOutput) SetArn added in v1.44.156

SetArn sets the Arn field's value.

func (*GetSyncJobOutput) SetCreationDateTime added in v1.44.156

func (s *GetSyncJobOutput) SetCreationDateTime(v time.Time) *GetSyncJobOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*GetSyncJobOutput) SetStatus added in v1.44.156

SetStatus sets the Status field's value.

func (*GetSyncJobOutput) SetSyncRole added in v1.44.156

func (s *GetSyncJobOutput) SetSyncRole(v string) *GetSyncJobOutput

SetSyncRole sets the SyncRole field's value.

func (*GetSyncJobOutput) SetSyncSource added in v1.44.156

func (s *GetSyncJobOutput) SetSyncSource(v string) *GetSyncJobOutput

SetSyncSource sets the SyncSource field's value.

func (*GetSyncJobOutput) SetUpdateDateTime added in v1.44.156

func (s *GetSyncJobOutput) SetUpdateDateTime(v time.Time) *GetSyncJobOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*GetSyncJobOutput) SetWorkspaceId added in v1.44.156

func (s *GetSyncJobOutput) SetWorkspaceId(v string) *GetSyncJobOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetSyncJobOutput) String added in v1.44.156

func (s GetSyncJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetWorkspaceInput

type GetWorkspaceInput struct {

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetWorkspaceInput) GoString

func (s GetWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkspaceInput) SetWorkspaceId

func (s *GetWorkspaceInput) SetWorkspaceId(v string) *GetWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetWorkspaceInput) String

func (s GetWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkspaceInput) Validate

func (s *GetWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetWorkspaceOutput

type GetWorkspaceOutput struct {

	// The ARN of the workspace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the workspace was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the workspace.
	Description *string `locationName:"description" type:"string"`

	// The ARN of the execution role associated with the workspace.
	//
	// Role is a required field
	Role *string `locationName:"role" min:"20" type:"string" required:"true"`

	// The ARN of the S3 bucket where resources associated with the workspace are
	// stored.
	//
	// S3Location is a required field
	S3Location *string `locationName:"s3Location" type:"string" required:"true"`

	// The date and time when the workspace was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetWorkspaceOutput) GoString

func (s GetWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkspaceOutput) SetArn

SetArn sets the Arn field's value.

func (*GetWorkspaceOutput) SetCreationDateTime

func (s *GetWorkspaceOutput) SetCreationDateTime(v time.Time) *GetWorkspaceOutput

SetCreationDateTime sets the CreationDateTime field's value.

func (*GetWorkspaceOutput) SetDescription

func (s *GetWorkspaceOutput) SetDescription(v string) *GetWorkspaceOutput

SetDescription sets the Description field's value.

func (*GetWorkspaceOutput) SetRole

SetRole sets the Role field's value.

func (*GetWorkspaceOutput) SetS3Location

func (s *GetWorkspaceOutput) SetS3Location(v string) *GetWorkspaceOutput

SetS3Location sets the S3Location field's value.

func (*GetWorkspaceOutput) SetUpdateDateTime

func (s *GetWorkspaceOutput) SetUpdateDateTime(v time.Time) *GetWorkspaceOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*GetWorkspaceOutput) SetWorkspaceId

func (s *GetWorkspaceOutput) SetWorkspaceId(v string) *GetWorkspaceOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (GetWorkspaceOutput) String

func (s GetWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An unexpected error has occurred.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InterpolationParameters

type InterpolationParameters struct {

	// The interpolation type.
	InterpolationType *string `locationName:"interpolationType" type:"string" enum:"InterpolationType"`

	// The interpolation time interval in seconds.
	IntervalInSeconds *int64 `locationName:"intervalInSeconds" type:"long"`
	// contains filtered or unexported fields
}

An object that specifies how to interpolate data in a list.

func (InterpolationParameters) GoString

func (s InterpolationParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InterpolationParameters) SetInterpolationType

func (s *InterpolationParameters) SetInterpolationType(v string) *InterpolationParameters

SetInterpolationType sets the InterpolationType field's value.

func (*InterpolationParameters) SetIntervalInSeconds

func (s *InterpolationParameters) SetIntervalInSeconds(v int64) *InterpolationParameters

SetIntervalInSeconds sets the IntervalInSeconds field's value.

func (InterpolationParameters) String

func (s InterpolationParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTTwinMaker

type IoTTwinMaker struct {
	*client.Client
}

IoTTwinMaker provides the API operation methods for making requests to AWS IoT TwinMaker. See this package's package overview docs for details on the service.

IoTTwinMaker methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTTwinMaker

New creates a new instance of the IoTTwinMaker client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a IoTTwinMaker client from just a session.
svc := iottwinmaker.New(mySession)

// Create a IoTTwinMaker client with additional configuration
svc := iottwinmaker.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTTwinMaker) BatchPutPropertyValues

func (c *IoTTwinMaker) BatchPutPropertyValues(input *BatchPutPropertyValuesInput) (*BatchPutPropertyValuesOutput, error)

BatchPutPropertyValues API operation for AWS IoT TwinMaker.

Sets values for multiple time series properties.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation BatchPutPropertyValues for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/BatchPutPropertyValues

func (*IoTTwinMaker) BatchPutPropertyValuesRequest

func (c *IoTTwinMaker) BatchPutPropertyValuesRequest(input *BatchPutPropertyValuesInput) (req *request.Request, output *BatchPutPropertyValuesOutput)

BatchPutPropertyValuesRequest generates a "aws/request.Request" representing the client's request for the BatchPutPropertyValues operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutPropertyValues for more information on using the BatchPutPropertyValues API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchPutPropertyValuesRequest method.
req, resp := client.BatchPutPropertyValuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/BatchPutPropertyValues

func (*IoTTwinMaker) BatchPutPropertyValuesWithContext

func (c *IoTTwinMaker) BatchPutPropertyValuesWithContext(ctx aws.Context, input *BatchPutPropertyValuesInput, opts ...request.Option) (*BatchPutPropertyValuesOutput, error)

BatchPutPropertyValuesWithContext is the same as BatchPutPropertyValues with the addition of the ability to pass a context and additional request options.

See BatchPutPropertyValues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) CreateComponentType

func (c *IoTTwinMaker) CreateComponentType(input *CreateComponentTypeInput) (*CreateComponentTypeOutput, error)

CreateComponentType API operation for AWS IoT TwinMaker.

Creates a component type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation CreateComponentType for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConflictException A conflict occurred.

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateComponentType

func (*IoTTwinMaker) CreateComponentTypeRequest

func (c *IoTTwinMaker) CreateComponentTypeRequest(input *CreateComponentTypeInput) (req *request.Request, output *CreateComponentTypeOutput)

CreateComponentTypeRequest generates a "aws/request.Request" representing the client's request for the CreateComponentType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateComponentType for more information on using the CreateComponentType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateComponentTypeRequest method.
req, resp := client.CreateComponentTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateComponentType

func (*IoTTwinMaker) CreateComponentTypeWithContext

func (c *IoTTwinMaker) CreateComponentTypeWithContext(ctx aws.Context, input *CreateComponentTypeInput, opts ...request.Option) (*CreateComponentTypeOutput, error)

CreateComponentTypeWithContext is the same as CreateComponentType with the addition of the ability to pass a context and additional request options.

See CreateComponentType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) CreateEntity

func (c *IoTTwinMaker) CreateEntity(input *CreateEntityInput) (*CreateEntityOutput, error)

CreateEntity API operation for AWS IoT TwinMaker.

Creates an entity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation CreateEntity for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConflictException A conflict occurred.

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateEntity

func (*IoTTwinMaker) CreateEntityRequest

func (c *IoTTwinMaker) CreateEntityRequest(input *CreateEntityInput) (req *request.Request, output *CreateEntityOutput)

CreateEntityRequest generates a "aws/request.Request" representing the client's request for the CreateEntity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEntity for more information on using the CreateEntity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEntityRequest method.
req, resp := client.CreateEntityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateEntity

func (*IoTTwinMaker) CreateEntityWithContext

func (c *IoTTwinMaker) CreateEntityWithContext(ctx aws.Context, input *CreateEntityInput, opts ...request.Option) (*CreateEntityOutput, error)

CreateEntityWithContext is the same as CreateEntity with the addition of the ability to pass a context and additional request options.

See CreateEntity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) CreateScene

func (c *IoTTwinMaker) CreateScene(input *CreateSceneInput) (*CreateSceneOutput, error)

CreateScene API operation for AWS IoT TwinMaker.

Creates a scene.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation CreateScene for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConflictException A conflict occurred.

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateScene

func (*IoTTwinMaker) CreateSceneRequest

func (c *IoTTwinMaker) CreateSceneRequest(input *CreateSceneInput) (req *request.Request, output *CreateSceneOutput)

CreateSceneRequest generates a "aws/request.Request" representing the client's request for the CreateScene operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateScene for more information on using the CreateScene API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSceneRequest method.
req, resp := client.CreateSceneRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateScene

func (*IoTTwinMaker) CreateSceneWithContext

func (c *IoTTwinMaker) CreateSceneWithContext(ctx aws.Context, input *CreateSceneInput, opts ...request.Option) (*CreateSceneOutput, error)

CreateSceneWithContext is the same as CreateScene with the addition of the ability to pass a context and additional request options.

See CreateScene for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) CreateSyncJob added in v1.44.156

func (c *IoTTwinMaker) CreateSyncJob(input *CreateSyncJobInput) (*CreateSyncJobOutput, error)

CreateSyncJob API operation for AWS IoT TwinMaker.

This action creates a SyncJob.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation CreateSyncJob for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConflictException A conflict occurred.

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateSyncJob

func (*IoTTwinMaker) CreateSyncJobRequest added in v1.44.156

func (c *IoTTwinMaker) CreateSyncJobRequest(input *CreateSyncJobInput) (req *request.Request, output *CreateSyncJobOutput)

CreateSyncJobRequest generates a "aws/request.Request" representing the client's request for the CreateSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSyncJob for more information on using the CreateSyncJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSyncJobRequest method.
req, resp := client.CreateSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateSyncJob

func (*IoTTwinMaker) CreateSyncJobWithContext added in v1.44.156

func (c *IoTTwinMaker) CreateSyncJobWithContext(ctx aws.Context, input *CreateSyncJobInput, opts ...request.Option) (*CreateSyncJobOutput, error)

CreateSyncJobWithContext is the same as CreateSyncJob with the addition of the ability to pass a context and additional request options.

See CreateSyncJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) CreateWorkspace

func (c *IoTTwinMaker) CreateWorkspace(input *CreateWorkspaceInput) (*CreateWorkspaceOutput, error)

CreateWorkspace API operation for AWS IoT TwinMaker.

Creates a workplace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation CreateWorkspace for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConflictException A conflict occurred.

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateWorkspace

func (*IoTTwinMaker) CreateWorkspaceRequest

func (c *IoTTwinMaker) CreateWorkspaceRequest(input *CreateWorkspaceInput) (req *request.Request, output *CreateWorkspaceOutput)

CreateWorkspaceRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspace for more information on using the CreateWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateWorkspaceRequest method.
req, resp := client.CreateWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CreateWorkspace

func (*IoTTwinMaker) CreateWorkspaceWithContext

func (c *IoTTwinMaker) CreateWorkspaceWithContext(ctx aws.Context, input *CreateWorkspaceInput, opts ...request.Option) (*CreateWorkspaceOutput, error)

CreateWorkspaceWithContext is the same as CreateWorkspace with the addition of the ability to pass a context and additional request options.

See CreateWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) DeleteComponentType

func (c *IoTTwinMaker) DeleteComponentType(input *DeleteComponentTypeInput) (*DeleteComponentTypeOutput, error)

DeleteComponentType API operation for AWS IoT TwinMaker.

Deletes a component type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation DeleteComponentType for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteComponentType

func (*IoTTwinMaker) DeleteComponentTypeRequest

func (c *IoTTwinMaker) DeleteComponentTypeRequest(input *DeleteComponentTypeInput) (req *request.Request, output *DeleteComponentTypeOutput)

DeleteComponentTypeRequest generates a "aws/request.Request" representing the client's request for the DeleteComponentType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteComponentType for more information on using the DeleteComponentType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteComponentTypeRequest method.
req, resp := client.DeleteComponentTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteComponentType

func (*IoTTwinMaker) DeleteComponentTypeWithContext

func (c *IoTTwinMaker) DeleteComponentTypeWithContext(ctx aws.Context, input *DeleteComponentTypeInput, opts ...request.Option) (*DeleteComponentTypeOutput, error)

DeleteComponentTypeWithContext is the same as DeleteComponentType with the addition of the ability to pass a context and additional request options.

See DeleteComponentType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) DeleteEntity

func (c *IoTTwinMaker) DeleteEntity(input *DeleteEntityInput) (*DeleteEntityOutput, error)

DeleteEntity API operation for AWS IoT TwinMaker.

Deletes an entity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation DeleteEntity for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteEntity

func (*IoTTwinMaker) DeleteEntityRequest

func (c *IoTTwinMaker) DeleteEntityRequest(input *DeleteEntityInput) (req *request.Request, output *DeleteEntityOutput)

DeleteEntityRequest generates a "aws/request.Request" representing the client's request for the DeleteEntity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEntity for more information on using the DeleteEntity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEntityRequest method.
req, resp := client.DeleteEntityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteEntity

func (*IoTTwinMaker) DeleteEntityWithContext

func (c *IoTTwinMaker) DeleteEntityWithContext(ctx aws.Context, input *DeleteEntityInput, opts ...request.Option) (*DeleteEntityOutput, error)

DeleteEntityWithContext is the same as DeleteEntity with the addition of the ability to pass a context and additional request options.

See DeleteEntity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) DeleteScene

func (c *IoTTwinMaker) DeleteScene(input *DeleteSceneInput) (*DeleteSceneOutput, error)

DeleteScene API operation for AWS IoT TwinMaker.

Deletes a scene.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation DeleteScene for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteScene

func (*IoTTwinMaker) DeleteSceneRequest

func (c *IoTTwinMaker) DeleteSceneRequest(input *DeleteSceneInput) (req *request.Request, output *DeleteSceneOutput)

DeleteSceneRequest generates a "aws/request.Request" representing the client's request for the DeleteScene operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteScene for more information on using the DeleteScene API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSceneRequest method.
req, resp := client.DeleteSceneRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteScene

func (*IoTTwinMaker) DeleteSceneWithContext

func (c *IoTTwinMaker) DeleteSceneWithContext(ctx aws.Context, input *DeleteSceneInput, opts ...request.Option) (*DeleteSceneOutput, error)

DeleteSceneWithContext is the same as DeleteScene with the addition of the ability to pass a context and additional request options.

See DeleteScene for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) DeleteSyncJob added in v1.44.156

func (c *IoTTwinMaker) DeleteSyncJob(input *DeleteSyncJobInput) (*DeleteSyncJobOutput, error)

DeleteSyncJob API operation for AWS IoT TwinMaker.

Delete the SyncJob.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation DeleteSyncJob for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteSyncJob

func (*IoTTwinMaker) DeleteSyncJobRequest added in v1.44.156

func (c *IoTTwinMaker) DeleteSyncJobRequest(input *DeleteSyncJobInput) (req *request.Request, output *DeleteSyncJobOutput)

DeleteSyncJobRequest generates a "aws/request.Request" representing the client's request for the DeleteSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSyncJob for more information on using the DeleteSyncJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSyncJobRequest method.
req, resp := client.DeleteSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteSyncJob

func (*IoTTwinMaker) DeleteSyncJobWithContext added in v1.44.156

func (c *IoTTwinMaker) DeleteSyncJobWithContext(ctx aws.Context, input *DeleteSyncJobInput, opts ...request.Option) (*DeleteSyncJobOutput, error)

DeleteSyncJobWithContext is the same as DeleteSyncJob with the addition of the ability to pass a context and additional request options.

See DeleteSyncJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) DeleteWorkspace

func (c *IoTTwinMaker) DeleteWorkspace(input *DeleteWorkspaceInput) (*DeleteWorkspaceOutput, error)

DeleteWorkspace API operation for AWS IoT TwinMaker.

Deletes a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation DeleteWorkspace for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteWorkspace

func (*IoTTwinMaker) DeleteWorkspaceRequest

func (c *IoTTwinMaker) DeleteWorkspaceRequest(input *DeleteWorkspaceInput) (req *request.Request, output *DeleteWorkspaceOutput)

DeleteWorkspaceRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkspace for more information on using the DeleteWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteWorkspaceRequest method.
req, resp := client.DeleteWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/DeleteWorkspace

func (*IoTTwinMaker) DeleteWorkspaceWithContext

func (c *IoTTwinMaker) DeleteWorkspaceWithContext(ctx aws.Context, input *DeleteWorkspaceInput, opts ...request.Option) (*DeleteWorkspaceOutput, error)

DeleteWorkspaceWithContext is the same as DeleteWorkspace with the addition of the ability to pass a context and additional request options.

See DeleteWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ExecuteQuery added in v1.44.139

func (c *IoTTwinMaker) ExecuteQuery(input *ExecuteQueryInput) (*ExecuteQueryOutput, error)

ExecuteQuery API operation for AWS IoT TwinMaker.

Run queries to access information from your knowledge graph of entities within individual workspaces.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ExecuteQuery for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • QueryTimeoutException The query timeout exception.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ExecuteQuery

func (*IoTTwinMaker) ExecuteQueryPages added in v1.44.139

func (c *IoTTwinMaker) ExecuteQueryPages(input *ExecuteQueryInput, fn func(*ExecuteQueryOutput, bool) bool) error

ExecuteQueryPages iterates over the pages of a ExecuteQuery operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ExecuteQuery method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ExecuteQuery operation.
pageNum := 0
err := client.ExecuteQueryPages(params,
    func(page *iottwinmaker.ExecuteQueryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ExecuteQueryPagesWithContext added in v1.44.139

func (c *IoTTwinMaker) ExecuteQueryPagesWithContext(ctx aws.Context, input *ExecuteQueryInput, fn func(*ExecuteQueryOutput, bool) bool, opts ...request.Option) error

ExecuteQueryPagesWithContext same as ExecuteQueryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ExecuteQueryRequest added in v1.44.139

func (c *IoTTwinMaker) ExecuteQueryRequest(input *ExecuteQueryInput) (req *request.Request, output *ExecuteQueryOutput)

ExecuteQueryRequest generates a "aws/request.Request" representing the client's request for the ExecuteQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExecuteQuery for more information on using the ExecuteQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExecuteQueryRequest method.
req, resp := client.ExecuteQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ExecuteQuery

func (*IoTTwinMaker) ExecuteQueryWithContext added in v1.44.139

func (c *IoTTwinMaker) ExecuteQueryWithContext(ctx aws.Context, input *ExecuteQueryInput, opts ...request.Option) (*ExecuteQueryOutput, error)

ExecuteQueryWithContext is the same as ExecuteQuery with the addition of the ability to pass a context and additional request options.

See ExecuteQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetComponentType

func (c *IoTTwinMaker) GetComponentType(input *GetComponentTypeInput) (*GetComponentTypeOutput, error)

GetComponentType API operation for AWS IoT TwinMaker.

Retrieves information about a component type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetComponentType for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetComponentType

func (*IoTTwinMaker) GetComponentTypeRequest

func (c *IoTTwinMaker) GetComponentTypeRequest(input *GetComponentTypeInput) (req *request.Request, output *GetComponentTypeOutput)

GetComponentTypeRequest generates a "aws/request.Request" representing the client's request for the GetComponentType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComponentType for more information on using the GetComponentType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetComponentTypeRequest method.
req, resp := client.GetComponentTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetComponentType

func (*IoTTwinMaker) GetComponentTypeWithContext

func (c *IoTTwinMaker) GetComponentTypeWithContext(ctx aws.Context, input *GetComponentTypeInput, opts ...request.Option) (*GetComponentTypeOutput, error)

GetComponentTypeWithContext is the same as GetComponentType with the addition of the ability to pass a context and additional request options.

See GetComponentType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetEntity

func (c *IoTTwinMaker) GetEntity(input *GetEntityInput) (*GetEntityOutput, error)

GetEntity API operation for AWS IoT TwinMaker.

Retrieves information about an entity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetEntity for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetEntity

func (*IoTTwinMaker) GetEntityRequest

func (c *IoTTwinMaker) GetEntityRequest(input *GetEntityInput) (req *request.Request, output *GetEntityOutput)

GetEntityRequest generates a "aws/request.Request" representing the client's request for the GetEntity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEntity for more information on using the GetEntity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetEntityRequest method.
req, resp := client.GetEntityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetEntity

func (*IoTTwinMaker) GetEntityWithContext

func (c *IoTTwinMaker) GetEntityWithContext(ctx aws.Context, input *GetEntityInput, opts ...request.Option) (*GetEntityOutput, error)

GetEntityWithContext is the same as GetEntity with the addition of the ability to pass a context and additional request options.

See GetEntity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetPricingPlan added in v1.44.139

func (c *IoTTwinMaker) GetPricingPlan(input *GetPricingPlanInput) (*GetPricingPlanOutput, error)

GetPricingPlan API operation for AWS IoT TwinMaker.

Gets the pricing plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetPricingPlan for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetPricingPlan

func (*IoTTwinMaker) GetPricingPlanRequest added in v1.44.139

func (c *IoTTwinMaker) GetPricingPlanRequest(input *GetPricingPlanInput) (req *request.Request, output *GetPricingPlanOutput)

GetPricingPlanRequest generates a "aws/request.Request" representing the client's request for the GetPricingPlan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPricingPlan for more information on using the GetPricingPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPricingPlanRequest method.
req, resp := client.GetPricingPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetPricingPlan

func (*IoTTwinMaker) GetPricingPlanWithContext added in v1.44.139

func (c *IoTTwinMaker) GetPricingPlanWithContext(ctx aws.Context, input *GetPricingPlanInput, opts ...request.Option) (*GetPricingPlanOutput, error)

GetPricingPlanWithContext is the same as GetPricingPlan with the addition of the ability to pass a context and additional request options.

See GetPricingPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetPropertyValue

func (c *IoTTwinMaker) GetPropertyValue(input *GetPropertyValueInput) (*GetPropertyValueOutput, error)

GetPropertyValue API operation for AWS IoT TwinMaker.

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetPropertyValue for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ConnectorFailureException The connector failed.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConnectorTimeoutException The connector timed out.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetPropertyValue

func (*IoTTwinMaker) GetPropertyValueHistory

func (c *IoTTwinMaker) GetPropertyValueHistory(input *GetPropertyValueHistoryInput) (*GetPropertyValueHistoryOutput, error)

GetPropertyValueHistory API operation for AWS IoT TwinMaker.

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetPropertyValueHistory for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ConnectorFailureException The connector failed.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConnectorTimeoutException The connector timed out.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetPropertyValueHistory

func (*IoTTwinMaker) GetPropertyValueHistoryPages

func (c *IoTTwinMaker) GetPropertyValueHistoryPages(input *GetPropertyValueHistoryInput, fn func(*GetPropertyValueHistoryOutput, bool) bool) error

GetPropertyValueHistoryPages iterates over the pages of a GetPropertyValueHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetPropertyValueHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetPropertyValueHistory operation.
pageNum := 0
err := client.GetPropertyValueHistoryPages(params,
    func(page *iottwinmaker.GetPropertyValueHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) GetPropertyValueHistoryPagesWithContext

func (c *IoTTwinMaker) GetPropertyValueHistoryPagesWithContext(ctx aws.Context, input *GetPropertyValueHistoryInput, fn func(*GetPropertyValueHistoryOutput, bool) bool, opts ...request.Option) error

GetPropertyValueHistoryPagesWithContext same as GetPropertyValueHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetPropertyValueHistoryRequest

func (c *IoTTwinMaker) GetPropertyValueHistoryRequest(input *GetPropertyValueHistoryInput) (req *request.Request, output *GetPropertyValueHistoryOutput)

GetPropertyValueHistoryRequest generates a "aws/request.Request" representing the client's request for the GetPropertyValueHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPropertyValueHistory for more information on using the GetPropertyValueHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPropertyValueHistoryRequest method.
req, resp := client.GetPropertyValueHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetPropertyValueHistory

func (*IoTTwinMaker) GetPropertyValueHistoryWithContext

func (c *IoTTwinMaker) GetPropertyValueHistoryWithContext(ctx aws.Context, input *GetPropertyValueHistoryInput, opts ...request.Option) (*GetPropertyValueHistoryOutput, error)

GetPropertyValueHistoryWithContext is the same as GetPropertyValueHistory with the addition of the ability to pass a context and additional request options.

See GetPropertyValueHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetPropertyValuePages added in v1.44.139

func (c *IoTTwinMaker) GetPropertyValuePages(input *GetPropertyValueInput, fn func(*GetPropertyValueOutput, bool) bool) error

GetPropertyValuePages iterates over the pages of a GetPropertyValue operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetPropertyValue method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetPropertyValue operation.
pageNum := 0
err := client.GetPropertyValuePages(params,
    func(page *iottwinmaker.GetPropertyValueOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) GetPropertyValuePagesWithContext added in v1.44.139

func (c *IoTTwinMaker) GetPropertyValuePagesWithContext(ctx aws.Context, input *GetPropertyValueInput, fn func(*GetPropertyValueOutput, bool) bool, opts ...request.Option) error

GetPropertyValuePagesWithContext same as GetPropertyValuePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetPropertyValueRequest

func (c *IoTTwinMaker) GetPropertyValueRequest(input *GetPropertyValueInput) (req *request.Request, output *GetPropertyValueOutput)

GetPropertyValueRequest generates a "aws/request.Request" representing the client's request for the GetPropertyValue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPropertyValue for more information on using the GetPropertyValue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPropertyValueRequest method.
req, resp := client.GetPropertyValueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetPropertyValue

func (*IoTTwinMaker) GetPropertyValueWithContext

func (c *IoTTwinMaker) GetPropertyValueWithContext(ctx aws.Context, input *GetPropertyValueInput, opts ...request.Option) (*GetPropertyValueOutput, error)

GetPropertyValueWithContext is the same as GetPropertyValue with the addition of the ability to pass a context and additional request options.

See GetPropertyValue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetScene

func (c *IoTTwinMaker) GetScene(input *GetSceneInput) (*GetSceneOutput, error)

GetScene API operation for AWS IoT TwinMaker.

Retrieves information about a scene.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetScene for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetScene

func (*IoTTwinMaker) GetSceneRequest

func (c *IoTTwinMaker) GetSceneRequest(input *GetSceneInput) (req *request.Request, output *GetSceneOutput)

GetSceneRequest generates a "aws/request.Request" representing the client's request for the GetScene operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetScene for more information on using the GetScene API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSceneRequest method.
req, resp := client.GetSceneRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetScene

func (*IoTTwinMaker) GetSceneWithContext

func (c *IoTTwinMaker) GetSceneWithContext(ctx aws.Context, input *GetSceneInput, opts ...request.Option) (*GetSceneOutput, error)

GetSceneWithContext is the same as GetScene with the addition of the ability to pass a context and additional request options.

See GetScene for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetSyncJob added in v1.44.156

func (c *IoTTwinMaker) GetSyncJob(input *GetSyncJobInput) (*GetSyncJobOutput, error)

GetSyncJob API operation for AWS IoT TwinMaker.

Gets the SyncJob.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetSyncJob for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetSyncJob

func (*IoTTwinMaker) GetSyncJobRequest added in v1.44.156

func (c *IoTTwinMaker) GetSyncJobRequest(input *GetSyncJobInput) (req *request.Request, output *GetSyncJobOutput)

GetSyncJobRequest generates a "aws/request.Request" representing the client's request for the GetSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSyncJob for more information on using the GetSyncJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSyncJobRequest method.
req, resp := client.GetSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetSyncJob

func (*IoTTwinMaker) GetSyncJobWithContext added in v1.44.156

func (c *IoTTwinMaker) GetSyncJobWithContext(ctx aws.Context, input *GetSyncJobInput, opts ...request.Option) (*GetSyncJobOutput, error)

GetSyncJobWithContext is the same as GetSyncJob with the addition of the ability to pass a context and additional request options.

See GetSyncJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) GetWorkspace

func (c *IoTTwinMaker) GetWorkspace(input *GetWorkspaceInput) (*GetWorkspaceOutput, error)

GetWorkspace API operation for AWS IoT TwinMaker.

Retrieves information about a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation GetWorkspace for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetWorkspace

func (*IoTTwinMaker) GetWorkspaceRequest

func (c *IoTTwinMaker) GetWorkspaceRequest(input *GetWorkspaceInput) (req *request.Request, output *GetWorkspaceOutput)

GetWorkspaceRequest generates a "aws/request.Request" representing the client's request for the GetWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWorkspace for more information on using the GetWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetWorkspaceRequest method.
req, resp := client.GetWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetWorkspace

func (*IoTTwinMaker) GetWorkspaceWithContext

func (c *IoTTwinMaker) GetWorkspaceWithContext(ctx aws.Context, input *GetWorkspaceInput, opts ...request.Option) (*GetWorkspaceOutput, error)

GetWorkspaceWithContext is the same as GetWorkspace with the addition of the ability to pass a context and additional request options.

See GetWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListComponentTypes

func (c *IoTTwinMaker) ListComponentTypes(input *ListComponentTypesInput) (*ListComponentTypesOutput, error)

ListComponentTypes API operation for AWS IoT TwinMaker.

Lists all component types in a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListComponentTypes for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListComponentTypes

func (*IoTTwinMaker) ListComponentTypesPages

func (c *IoTTwinMaker) ListComponentTypesPages(input *ListComponentTypesInput, fn func(*ListComponentTypesOutput, bool) bool) error

ListComponentTypesPages iterates over the pages of a ListComponentTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListComponentTypes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListComponentTypes operation.
pageNum := 0
err := client.ListComponentTypesPages(params,
    func(page *iottwinmaker.ListComponentTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ListComponentTypesPagesWithContext

func (c *IoTTwinMaker) ListComponentTypesPagesWithContext(ctx aws.Context, input *ListComponentTypesInput, fn func(*ListComponentTypesOutput, bool) bool, opts ...request.Option) error

ListComponentTypesPagesWithContext same as ListComponentTypesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListComponentTypesRequest

func (c *IoTTwinMaker) ListComponentTypesRequest(input *ListComponentTypesInput) (req *request.Request, output *ListComponentTypesOutput)

ListComponentTypesRequest generates a "aws/request.Request" representing the client's request for the ListComponentTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListComponentTypes for more information on using the ListComponentTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListComponentTypesRequest method.
req, resp := client.ListComponentTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListComponentTypes

func (*IoTTwinMaker) ListComponentTypesWithContext

func (c *IoTTwinMaker) ListComponentTypesWithContext(ctx aws.Context, input *ListComponentTypesInput, opts ...request.Option) (*ListComponentTypesOutput, error)

ListComponentTypesWithContext is the same as ListComponentTypes with the addition of the ability to pass a context and additional request options.

See ListComponentTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListEntities

func (c *IoTTwinMaker) ListEntities(input *ListEntitiesInput) (*ListEntitiesOutput, error)

ListEntities API operation for AWS IoT TwinMaker.

Lists all entities in a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListEntities for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListEntities

func (*IoTTwinMaker) ListEntitiesPages

func (c *IoTTwinMaker) ListEntitiesPages(input *ListEntitiesInput, fn func(*ListEntitiesOutput, bool) bool) error

ListEntitiesPages iterates over the pages of a ListEntities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEntities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListEntities operation.
pageNum := 0
err := client.ListEntitiesPages(params,
    func(page *iottwinmaker.ListEntitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ListEntitiesPagesWithContext

func (c *IoTTwinMaker) ListEntitiesPagesWithContext(ctx aws.Context, input *ListEntitiesInput, fn func(*ListEntitiesOutput, bool) bool, opts ...request.Option) error

ListEntitiesPagesWithContext same as ListEntitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListEntitiesRequest

func (c *IoTTwinMaker) ListEntitiesRequest(input *ListEntitiesInput) (req *request.Request, output *ListEntitiesOutput)

ListEntitiesRequest generates a "aws/request.Request" representing the client's request for the ListEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEntities for more information on using the ListEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEntitiesRequest method.
req, resp := client.ListEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListEntities

func (*IoTTwinMaker) ListEntitiesWithContext

func (c *IoTTwinMaker) ListEntitiesWithContext(ctx aws.Context, input *ListEntitiesInput, opts ...request.Option) (*ListEntitiesOutput, error)

ListEntitiesWithContext is the same as ListEntities with the addition of the ability to pass a context and additional request options.

See ListEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListScenes

func (c *IoTTwinMaker) ListScenes(input *ListScenesInput) (*ListScenesOutput, error)

ListScenes API operation for AWS IoT TwinMaker.

Lists all scenes in a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListScenes for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListScenes

func (*IoTTwinMaker) ListScenesPages

func (c *IoTTwinMaker) ListScenesPages(input *ListScenesInput, fn func(*ListScenesOutput, bool) bool) error

ListScenesPages iterates over the pages of a ListScenes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListScenes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListScenes operation.
pageNum := 0
err := client.ListScenesPages(params,
    func(page *iottwinmaker.ListScenesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ListScenesPagesWithContext

func (c *IoTTwinMaker) ListScenesPagesWithContext(ctx aws.Context, input *ListScenesInput, fn func(*ListScenesOutput, bool) bool, opts ...request.Option) error

ListScenesPagesWithContext same as ListScenesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListScenesRequest

func (c *IoTTwinMaker) ListScenesRequest(input *ListScenesInput) (req *request.Request, output *ListScenesOutput)

ListScenesRequest generates a "aws/request.Request" representing the client's request for the ListScenes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListScenes for more information on using the ListScenes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListScenesRequest method.
req, resp := client.ListScenesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListScenes

func (*IoTTwinMaker) ListScenesWithContext

func (c *IoTTwinMaker) ListScenesWithContext(ctx aws.Context, input *ListScenesInput, opts ...request.Option) (*ListScenesOutput, error)

ListScenesWithContext is the same as ListScenes with the addition of the ability to pass a context and additional request options.

See ListScenes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListSyncJobs added in v1.44.156

func (c *IoTTwinMaker) ListSyncJobs(input *ListSyncJobsInput) (*ListSyncJobsOutput, error)

ListSyncJobs API operation for AWS IoT TwinMaker.

List all SyncJobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListSyncJobs for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListSyncJobs

func (*IoTTwinMaker) ListSyncJobsPages added in v1.44.156

func (c *IoTTwinMaker) ListSyncJobsPages(input *ListSyncJobsInput, fn func(*ListSyncJobsOutput, bool) bool) error

ListSyncJobsPages iterates over the pages of a ListSyncJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSyncJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSyncJobs operation.
pageNum := 0
err := client.ListSyncJobsPages(params,
    func(page *iottwinmaker.ListSyncJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ListSyncJobsPagesWithContext added in v1.44.156

func (c *IoTTwinMaker) ListSyncJobsPagesWithContext(ctx aws.Context, input *ListSyncJobsInput, fn func(*ListSyncJobsOutput, bool) bool, opts ...request.Option) error

ListSyncJobsPagesWithContext same as ListSyncJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListSyncJobsRequest added in v1.44.156

func (c *IoTTwinMaker) ListSyncJobsRequest(input *ListSyncJobsInput) (req *request.Request, output *ListSyncJobsOutput)

ListSyncJobsRequest generates a "aws/request.Request" representing the client's request for the ListSyncJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSyncJobs for more information on using the ListSyncJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSyncJobsRequest method.
req, resp := client.ListSyncJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListSyncJobs

func (*IoTTwinMaker) ListSyncJobsWithContext added in v1.44.156

func (c *IoTTwinMaker) ListSyncJobsWithContext(ctx aws.Context, input *ListSyncJobsInput, opts ...request.Option) (*ListSyncJobsOutput, error)

ListSyncJobsWithContext is the same as ListSyncJobs with the addition of the ability to pass a context and additional request options.

See ListSyncJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListSyncResources added in v1.44.156

func (c *IoTTwinMaker) ListSyncResources(input *ListSyncResourcesInput) (*ListSyncResourcesOutput, error)

ListSyncResources API operation for AWS IoT TwinMaker.

Lists the sync resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListSyncResources for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListSyncResources

func (*IoTTwinMaker) ListSyncResourcesPages added in v1.44.156

func (c *IoTTwinMaker) ListSyncResourcesPages(input *ListSyncResourcesInput, fn func(*ListSyncResourcesOutput, bool) bool) error

ListSyncResourcesPages iterates over the pages of a ListSyncResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSyncResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSyncResources operation.
pageNum := 0
err := client.ListSyncResourcesPages(params,
    func(page *iottwinmaker.ListSyncResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ListSyncResourcesPagesWithContext added in v1.44.156

func (c *IoTTwinMaker) ListSyncResourcesPagesWithContext(ctx aws.Context, input *ListSyncResourcesInput, fn func(*ListSyncResourcesOutput, bool) bool, opts ...request.Option) error

ListSyncResourcesPagesWithContext same as ListSyncResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListSyncResourcesRequest added in v1.44.156

func (c *IoTTwinMaker) ListSyncResourcesRequest(input *ListSyncResourcesInput) (req *request.Request, output *ListSyncResourcesOutput)

ListSyncResourcesRequest generates a "aws/request.Request" representing the client's request for the ListSyncResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSyncResources for more information on using the ListSyncResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSyncResourcesRequest method.
req, resp := client.ListSyncResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListSyncResources

func (*IoTTwinMaker) ListSyncResourcesWithContext added in v1.44.156

func (c *IoTTwinMaker) ListSyncResourcesWithContext(ctx aws.Context, input *ListSyncResourcesInput, opts ...request.Option) (*ListSyncResourcesOutput, error)

ListSyncResourcesWithContext is the same as ListSyncResources with the addition of the ability to pass a context and additional request options.

See ListSyncResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListTagsForResource

func (c *IoTTwinMaker) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT TwinMaker.

Lists all tags associated with a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListTagsForResource

func (*IoTTwinMaker) ListTagsForResourceRequest

func (c *IoTTwinMaker) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListTagsForResource

func (*IoTTwinMaker) ListTagsForResourceWithContext

func (c *IoTTwinMaker) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListWorkspaces

func (c *IoTTwinMaker) ListWorkspaces(input *ListWorkspacesInput) (*ListWorkspacesOutput, error)

ListWorkspaces API operation for AWS IoT TwinMaker.

Retrieves information about workspaces in the current account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation ListWorkspaces for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListWorkspaces

func (*IoTTwinMaker) ListWorkspacesPages

func (c *IoTTwinMaker) ListWorkspacesPages(input *ListWorkspacesInput, fn func(*ListWorkspacesOutput, bool) bool) error

ListWorkspacesPages iterates over the pages of a ListWorkspaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkspaces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkspaces operation.
pageNum := 0
err := client.ListWorkspacesPages(params,
    func(page *iottwinmaker.ListWorkspacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTTwinMaker) ListWorkspacesPagesWithContext

func (c *IoTTwinMaker) ListWorkspacesPagesWithContext(ctx aws.Context, input *ListWorkspacesInput, fn func(*ListWorkspacesOutput, bool) bool, opts ...request.Option) error

ListWorkspacesPagesWithContext same as ListWorkspacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) ListWorkspacesRequest

func (c *IoTTwinMaker) ListWorkspacesRequest(input *ListWorkspacesInput) (req *request.Request, output *ListWorkspacesOutput)

ListWorkspacesRequest generates a "aws/request.Request" representing the client's request for the ListWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkspaces for more information on using the ListWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkspacesRequest method.
req, resp := client.ListWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListWorkspaces

func (*IoTTwinMaker) ListWorkspacesWithContext

func (c *IoTTwinMaker) ListWorkspacesWithContext(ctx aws.Context, input *ListWorkspacesInput, opts ...request.Option) (*ListWorkspacesOutput, error)

ListWorkspacesWithContext is the same as ListWorkspaces with the addition of the ability to pass a context and additional request options.

See ListWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) TagResource

func (c *IoTTwinMaker) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT TwinMaker.

Adds tags to a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation TagResource for usage and error information.

Returned Error Types:

  • TooManyTagsException The number of tags exceeds the limit.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/TagResource

func (*IoTTwinMaker) TagResourceRequest

func (c *IoTTwinMaker) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/TagResource

func (*IoTTwinMaker) TagResourceWithContext

func (c *IoTTwinMaker) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) UntagResource

func (c *IoTTwinMaker) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT TwinMaker.

Removes tags from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation UntagResource for usage and error information.

Returned Error Types:

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UntagResource

func (*IoTTwinMaker) UntagResourceRequest

func (c *IoTTwinMaker) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UntagResource

func (*IoTTwinMaker) UntagResourceWithContext

func (c *IoTTwinMaker) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) UpdateComponentType

func (c *IoTTwinMaker) UpdateComponentType(input *UpdateComponentTypeInput) (*UpdateComponentTypeOutput, error)

UpdateComponentType API operation for AWS IoT TwinMaker.

Updates information in a component type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation UpdateComponentType for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateComponentType

func (*IoTTwinMaker) UpdateComponentTypeRequest

func (c *IoTTwinMaker) UpdateComponentTypeRequest(input *UpdateComponentTypeInput) (req *request.Request, output *UpdateComponentTypeOutput)

UpdateComponentTypeRequest generates a "aws/request.Request" representing the client's request for the UpdateComponentType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateComponentType for more information on using the UpdateComponentType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateComponentTypeRequest method.
req, resp := client.UpdateComponentTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateComponentType

func (*IoTTwinMaker) UpdateComponentTypeWithContext

func (c *IoTTwinMaker) UpdateComponentTypeWithContext(ctx aws.Context, input *UpdateComponentTypeInput, opts ...request.Option) (*UpdateComponentTypeOutput, error)

UpdateComponentTypeWithContext is the same as UpdateComponentType with the addition of the ability to pass a context and additional request options.

See UpdateComponentType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) UpdateEntity

func (c *IoTTwinMaker) UpdateEntity(input *UpdateEntityInput) (*UpdateEntityOutput, error)

UpdateEntity API operation for AWS IoT TwinMaker.

Updates an entity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation UpdateEntity for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ConflictException A conflict occurred.

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateEntity

func (*IoTTwinMaker) UpdateEntityRequest

func (c *IoTTwinMaker) UpdateEntityRequest(input *UpdateEntityInput) (req *request.Request, output *UpdateEntityOutput)

UpdateEntityRequest generates a "aws/request.Request" representing the client's request for the UpdateEntity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEntity for more information on using the UpdateEntity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateEntityRequest method.
req, resp := client.UpdateEntityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateEntity

func (*IoTTwinMaker) UpdateEntityWithContext

func (c *IoTTwinMaker) UpdateEntityWithContext(ctx aws.Context, input *UpdateEntityInput, opts ...request.Option) (*UpdateEntityOutput, error)

UpdateEntityWithContext is the same as UpdateEntity with the addition of the ability to pass a context and additional request options.

See UpdateEntity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) UpdatePricingPlan added in v1.44.139

func (c *IoTTwinMaker) UpdatePricingPlan(input *UpdatePricingPlanInput) (*UpdatePricingPlanOutput, error)

UpdatePricingPlan API operation for AWS IoT TwinMaker.

Update the pricing plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation UpdatePricingPlan for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdatePricingPlan

func (*IoTTwinMaker) UpdatePricingPlanRequest added in v1.44.139

func (c *IoTTwinMaker) UpdatePricingPlanRequest(input *UpdatePricingPlanInput) (req *request.Request, output *UpdatePricingPlanOutput)

UpdatePricingPlanRequest generates a "aws/request.Request" representing the client's request for the UpdatePricingPlan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePricingPlan for more information on using the UpdatePricingPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdatePricingPlanRequest method.
req, resp := client.UpdatePricingPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdatePricingPlan

func (*IoTTwinMaker) UpdatePricingPlanWithContext added in v1.44.139

func (c *IoTTwinMaker) UpdatePricingPlanWithContext(ctx aws.Context, input *UpdatePricingPlanInput, opts ...request.Option) (*UpdatePricingPlanOutput, error)

UpdatePricingPlanWithContext is the same as UpdatePricingPlan with the addition of the ability to pass a context and additional request options.

See UpdatePricingPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) UpdateScene

func (c *IoTTwinMaker) UpdateScene(input *UpdateSceneInput) (*UpdateSceneOutput, error)

UpdateScene API operation for AWS IoT TwinMaker.

Updates a scene.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation UpdateScene for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateScene

func (*IoTTwinMaker) UpdateSceneRequest

func (c *IoTTwinMaker) UpdateSceneRequest(input *UpdateSceneInput) (req *request.Request, output *UpdateSceneOutput)

UpdateSceneRequest generates a "aws/request.Request" representing the client's request for the UpdateScene operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateScene for more information on using the UpdateScene API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSceneRequest method.
req, resp := client.UpdateSceneRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateScene

func (*IoTTwinMaker) UpdateSceneWithContext

func (c *IoTTwinMaker) UpdateSceneWithContext(ctx aws.Context, input *UpdateSceneInput, opts ...request.Option) (*UpdateSceneOutput, error)

UpdateSceneWithContext is the same as UpdateScene with the addition of the ability to pass a context and additional request options.

See UpdateScene for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTTwinMaker) UpdateWorkspace

func (c *IoTTwinMaker) UpdateWorkspace(input *UpdateWorkspaceInput) (*UpdateWorkspaceOutput, error)

UpdateWorkspace API operation for AWS IoT TwinMaker.

Updates a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT TwinMaker's API operation UpdateWorkspace for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error has occurred.

  • AccessDeniedException Access is denied.

  • ResourceNotFoundException The resource wasn't found.

  • ThrottlingException The rate exceeds the limit.

  • ValidationException Failed

  • ServiceQuotaExceededException The service quota was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateWorkspace

func (*IoTTwinMaker) UpdateWorkspaceRequest

func (c *IoTTwinMaker) UpdateWorkspaceRequest(input *UpdateWorkspaceInput) (req *request.Request, output *UpdateWorkspaceOutput)

UpdateWorkspaceRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkspace for more information on using the UpdateWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateWorkspaceRequest method.
req, resp := client.UpdateWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/UpdateWorkspace

func (*IoTTwinMaker) UpdateWorkspaceWithContext

func (c *IoTTwinMaker) UpdateWorkspaceWithContext(ctx aws.Context, input *UpdateWorkspaceInput, opts ...request.Option) (*UpdateWorkspaceOutput, error)

UpdateWorkspaceWithContext is the same as UpdateWorkspace with the addition of the ability to pass a context and additional request options.

See UpdateWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type LambdaFunction

type LambdaFunction struct {

	// The ARN of the Lambda function.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Lambda function.

func (LambdaFunction) GoString

func (s LambdaFunction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaFunction) SetArn

func (s *LambdaFunction) SetArn(v string) *LambdaFunction

SetArn sets the Arn field's value.

func (LambdaFunction) String

func (s LambdaFunction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaFunction) Validate

func (s *LambdaFunction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComponentTypesFilter

type ListComponentTypesFilter struct {

	// The component type that the component types in the list extend.
	ExtendsFrom *string `locationName:"extendsFrom" min:"1" type:"string"`

	// A Boolean value that specifies whether the component types in the list are
	// abstract.
	IsAbstract *bool `locationName:"isAbstract" type:"boolean"`

	// The namespace to which the component types in the list belong.
	Namespace *string `locationName:"namespace" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that filters items in a list of component types.

Only one object is accepted as a valid input.

func (ListComponentTypesFilter) GoString

func (s ListComponentTypesFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentTypesFilter) SetExtendsFrom

SetExtendsFrom sets the ExtendsFrom field's value.

func (*ListComponentTypesFilter) SetIsAbstract

SetIsAbstract sets the IsAbstract field's value.

func (*ListComponentTypesFilter) SetNamespace

SetNamespace sets the Namespace field's value.

func (ListComponentTypesFilter) String

func (s ListComponentTypesFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentTypesFilter) Validate

func (s *ListComponentTypesFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComponentTypesInput

type ListComponentTypesInput struct {

	// A list of objects that filter the request.
	Filters []*ListComponentTypesFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListComponentTypesInput) GoString

func (s ListComponentTypesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentTypesInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListComponentTypesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListComponentTypesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListComponentTypesInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (ListComponentTypesInput) String

func (s ListComponentTypesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentTypesInput) Validate

func (s *ListComponentTypesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComponentTypesOutput

type ListComponentTypesOutput struct {

	// A list of objects that contain information about the component types.
	//
	// ComponentTypeSummaries is a required field
	ComponentTypeSummaries []*ComponentTypeSummary `locationName:"componentTypeSummaries" type:"list" required:"true"`

	// Specifies the maximum number of results to display.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListComponentTypesOutput) GoString

func (s ListComponentTypesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentTypesOutput) SetComponentTypeSummaries

func (s *ListComponentTypesOutput) SetComponentTypeSummaries(v []*ComponentTypeSummary) *ListComponentTypesOutput

SetComponentTypeSummaries sets the ComponentTypeSummaries field's value.

func (*ListComponentTypesOutput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListComponentTypesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListComponentTypesOutput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (ListComponentTypesOutput) String

func (s ListComponentTypesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEntitiesFilter

type ListEntitiesFilter struct {

	// The ID of the component type in the entities in the list.
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string"`

	// The external-Id property of a component. The external-Id property is the
	// primary key of an external storage system.
	ExternalId *string `locationName:"externalId" min:"1" type:"string"`

	// The parent of the entities in the list.
	ParentEntityId *string `locationName:"parentEntityId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that filters items in a list of entities.

func (ListEntitiesFilter) GoString

func (s ListEntitiesFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesFilter) SetComponentTypeId

func (s *ListEntitiesFilter) SetComponentTypeId(v string) *ListEntitiesFilter

SetComponentTypeId sets the ComponentTypeId field's value.

func (*ListEntitiesFilter) SetExternalId added in v1.43.38

func (s *ListEntitiesFilter) SetExternalId(v string) *ListEntitiesFilter

SetExternalId sets the ExternalId field's value.

func (*ListEntitiesFilter) SetParentEntityId

func (s *ListEntitiesFilter) SetParentEntityId(v string) *ListEntitiesFilter

SetParentEntityId sets the ParentEntityId field's value.

func (ListEntitiesFilter) String

func (s ListEntitiesFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesFilter) Validate

func (s *ListEntitiesFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntitiesInput

type ListEntitiesInput struct {

	// A list of objects that filter the request.
	//
	// Only one object is accepted as a valid input.
	Filters []*ListEntitiesFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListEntitiesInput) GoString

func (s ListEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListEntitiesInput) SetMaxResults

func (s *ListEntitiesInput) SetMaxResults(v int64) *ListEntitiesInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesInput) SetNextToken

func (s *ListEntitiesInput) SetNextToken(v string) *ListEntitiesInput

SetNextToken sets the NextToken field's value.

func (*ListEntitiesInput) SetWorkspaceId

func (s *ListEntitiesInput) SetWorkspaceId(v string) *ListEntitiesInput

SetWorkspaceId sets the WorkspaceId field's value.

func (ListEntitiesInput) String

func (s ListEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesInput) Validate

func (s *ListEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntitiesOutput

type ListEntitiesOutput struct {

	// A list of objects that contain information about the entities.
	EntitySummaries []*EntitySummary `locationName:"entitySummaries" type:"list"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesOutput) GoString

func (s ListEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesOutput) SetEntitySummaries

func (s *ListEntitiesOutput) SetEntitySummaries(v []*EntitySummary) *ListEntitiesOutput

SetEntitySummaries sets the EntitySummaries field's value.

func (*ListEntitiesOutput) SetNextToken

func (s *ListEntitiesOutput) SetNextToken(v string) *ListEntitiesOutput

SetNextToken sets the NextToken field's value.

func (ListEntitiesOutput) String

func (s ListEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListScenesInput

type ListScenesInput struct {

	// Specifies the maximum number of results to display.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ID of the workspace that contains the scenes.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListScenesInput) GoString

func (s ListScenesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScenesInput) SetMaxResults

func (s *ListScenesInput) SetMaxResults(v int64) *ListScenesInput

SetMaxResults sets the MaxResults field's value.

func (*ListScenesInput) SetNextToken

func (s *ListScenesInput) SetNextToken(v string) *ListScenesInput

SetNextToken sets the NextToken field's value.

func (*ListScenesInput) SetWorkspaceId

func (s *ListScenesInput) SetWorkspaceId(v string) *ListScenesInput

SetWorkspaceId sets the WorkspaceId field's value.

func (ListScenesInput) String

func (s ListScenesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScenesInput) Validate

func (s *ListScenesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListScenesOutput

type ListScenesOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of objects that contain information about the scenes.
	SceneSummaries []*SceneSummary `locationName:"sceneSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListScenesOutput) GoString

func (s ListScenesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScenesOutput) SetNextToken

func (s *ListScenesOutput) SetNextToken(v string) *ListScenesOutput

SetNextToken sets the NextToken field's value.

func (*ListScenesOutput) SetSceneSummaries

func (s *ListScenesOutput) SetSceneSummaries(v []*SceneSummary) *ListScenesOutput

SetSceneSummaries sets the SceneSummaries field's value.

func (ListScenesOutput) String

func (s ListScenesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSyncJobsInput added in v1.44.156

type ListSyncJobsInput struct {

	// The maximum number of results to return at one time. The default is 50.
	//
	// Valid Range: Minimum value of 0. Maximum value of 200.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ID of the workspace that contains the sync job.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListSyncJobsInput) GoString added in v1.44.156

func (s ListSyncJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSyncJobsInput) SetMaxResults added in v1.44.156

func (s *ListSyncJobsInput) SetMaxResults(v int64) *ListSyncJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSyncJobsInput) SetNextToken added in v1.44.156

func (s *ListSyncJobsInput) SetNextToken(v string) *ListSyncJobsInput

SetNextToken sets the NextToken field's value.

func (*ListSyncJobsInput) SetWorkspaceId added in v1.44.156

func (s *ListSyncJobsInput) SetWorkspaceId(v string) *ListSyncJobsInput

SetWorkspaceId sets the WorkspaceId field's value.

func (ListSyncJobsInput) String added in v1.44.156

func (s ListSyncJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSyncJobsInput) Validate added in v1.44.156

func (s *ListSyncJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSyncJobsOutput added in v1.44.156

type ListSyncJobsOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The listed SyncJob summaries.
	SyncJobSummaries []*SyncJobSummary `locationName:"syncJobSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListSyncJobsOutput) GoString added in v1.44.156

func (s ListSyncJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSyncJobsOutput) SetNextToken added in v1.44.156

func (s *ListSyncJobsOutput) SetNextToken(v string) *ListSyncJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListSyncJobsOutput) SetSyncJobSummaries added in v1.44.156

func (s *ListSyncJobsOutput) SetSyncJobSummaries(v []*SyncJobSummary) *ListSyncJobsOutput

SetSyncJobSummaries sets the SyncJobSummaries field's value.

func (ListSyncJobsOutput) String added in v1.44.156

func (s ListSyncJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSyncResourcesInput added in v1.44.156

type ListSyncResourcesInput struct {

	// A list of objects that filter the request.
	//
	// The following filter combinations are supported:
	//
	//    * Filter with state
	//
	//    * Filter with ResourceType and ResourceId
	//
	//    * Filter with ResourceType and ExternalId
	Filters []*SyncResourceFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return at one time. The default is 50.
	//
	// Valid Range: Minimum value of 0. Maximum value of 200.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The sync source.
	//
	// Currently the only supported syncSource is SITEWISE .
	//
	// SyncSource is a required field
	SyncSource *string `location:"uri" locationName:"syncSource" type:"string" required:"true"`

	// The ID of the workspace that contains the sync job.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListSyncResourcesInput) GoString added in v1.44.156

func (s ListSyncResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSyncResourcesInput) SetFilters added in v1.44.156

SetFilters sets the Filters field's value.

func (*ListSyncResourcesInput) SetMaxResults added in v1.44.156

SetMaxResults sets the MaxResults field's value.

func (*ListSyncResourcesInput) SetNextToken added in v1.44.156

SetNextToken sets the NextToken field's value.

func (*ListSyncResourcesInput) SetSyncSource added in v1.44.156

SetSyncSource sets the SyncSource field's value.

func (*ListSyncResourcesInput) SetWorkspaceId added in v1.44.156

SetWorkspaceId sets the WorkspaceId field's value.

func (ListSyncResourcesInput) String added in v1.44.156

func (s ListSyncResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSyncResourcesInput) Validate added in v1.44.156

func (s *ListSyncResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSyncResourcesOutput added in v1.44.156

type ListSyncResourcesOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The sync resources.
	SyncResources []*SyncResourceSummary `locationName:"syncResources" type:"list"`
	// contains filtered or unexported fields
}

func (ListSyncResourcesOutput) GoString added in v1.44.156

func (s ListSyncResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSyncResourcesOutput) SetNextToken added in v1.44.156

SetNextToken sets the NextToken field's value.

func (*ListSyncResourcesOutput) SetSyncResources added in v1.44.156

SetSyncResources sets the SyncResources field's value.

func (ListSyncResourcesOutput) String added in v1.44.156

func (s ListSyncResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ARN of the resource.
	//
	// ResourceARN is a required field
	ResourceARN *string `locationName:"resourceARN" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Metadata that you can use to manage a resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkspacesInput

type ListWorkspacesInput struct {

	// The maximum number of results to return at one time. The default is 25.
	//
	// Valid Range: Minimum value of 1. Maximum value of 250.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkspacesInput) GoString

func (s ListWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesInput) SetMaxResults

func (s *ListWorkspacesInput) SetMaxResults(v int64) *ListWorkspacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkspacesInput) SetNextToken

func (s *ListWorkspacesInput) SetNextToken(v string) *ListWorkspacesInput

SetNextToken sets the NextToken field's value.

func (ListWorkspacesInput) String

func (s ListWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkspacesOutput

type ListWorkspacesOutput struct {

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of objects that contain information about the workspaces.
	WorkspaceSummaries []*WorkspaceSummary `locationName:"workspaceSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListWorkspacesOutput) GoString

func (s ListWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesOutput) SetNextToken

func (s *ListWorkspacesOutput) SetNextToken(v string) *ListWorkspacesOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkspacesOutput) SetWorkspaceSummaries

func (s *ListWorkspacesOutput) SetWorkspaceSummaries(v []*WorkspaceSummary) *ListWorkspacesOutput

SetWorkspaceSummaries sets the WorkspaceSummaries field's value.

func (ListWorkspacesOutput) String

func (s ListWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrderBy added in v1.44.139

type OrderBy struct {

	// The set order that filters results.
	Order *string `locationName:"order" type:"string" enum:"Order"`

	// The property name.
	//
	// PropertyName is a required field
	PropertyName *string `locationName:"propertyName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Filter criteria that orders the return output. It can be sorted in ascending or descending order.

func (OrderBy) GoString added in v1.44.139

func (s OrderBy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrderBy) SetOrder added in v1.44.139

func (s *OrderBy) SetOrder(v string) *OrderBy

SetOrder sets the Order field's value.

func (*OrderBy) SetPropertyName added in v1.44.139

func (s *OrderBy) SetPropertyName(v string) *OrderBy

SetPropertyName sets the PropertyName field's value.

func (OrderBy) String added in v1.44.139

func (s OrderBy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrderBy) Validate added in v1.44.139

func (s *OrderBy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ParentEntityUpdateRequest

type ParentEntityUpdateRequest struct {

	// The ID of the parent entity.
	ParentEntityId *string `locationName:"parentEntityId" min:"1" type:"string"`

	// The type of the update.
	//
	// UpdateType is a required field
	UpdateType *string `locationName:"updateType" type:"string" required:"true" enum:"ParentEntityUpdateType"`
	// contains filtered or unexported fields
}

The parent entity update request.

func (ParentEntityUpdateRequest) GoString

func (s ParentEntityUpdateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParentEntityUpdateRequest) SetParentEntityId

SetParentEntityId sets the ParentEntityId field's value.

func (*ParentEntityUpdateRequest) SetUpdateType

SetUpdateType sets the UpdateType field's value.

func (ParentEntityUpdateRequest) String

func (s ParentEntityUpdateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParentEntityUpdateRequest) Validate

func (s *ParentEntityUpdateRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PricingPlan added in v1.44.139

type PricingPlan struct {

	// The billable entity count.
	BillableEntityCount *int64 `locationName:"billableEntityCount" type:"long"`

	// The pricing plan's bundle information.
	BundleInformation *BundleInformation `locationName:"bundleInformation" type:"structure"`

	// The effective date and time of the pricing plan.
	//
	// EffectiveDateTime is a required field
	EffectiveDateTime *time.Time `locationName:"effectiveDateTime" type:"timestamp" required:"true"`

	// The pricing mode.
	//
	// PricingMode is a required field
	PricingMode *string `locationName:"pricingMode" type:"string" required:"true" enum:"PricingMode"`

	// The set date and time for updating a pricing plan.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The update reason for changing a pricing plan.
	//
	// UpdateReason is a required field
	UpdateReason *string `locationName:"updateReason" type:"string" required:"true" enum:"UpdateReason"`
	// contains filtered or unexported fields
}

The pricing plan.

func (PricingPlan) GoString added in v1.44.139

func (s PricingPlan) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PricingPlan) SetBillableEntityCount added in v1.44.139

func (s *PricingPlan) SetBillableEntityCount(v int64) *PricingPlan

SetBillableEntityCount sets the BillableEntityCount field's value.

func (*PricingPlan) SetBundleInformation added in v1.44.139

func (s *PricingPlan) SetBundleInformation(v *BundleInformation) *PricingPlan

SetBundleInformation sets the BundleInformation field's value.

func (*PricingPlan) SetEffectiveDateTime added in v1.44.139

func (s *PricingPlan) SetEffectiveDateTime(v time.Time) *PricingPlan

SetEffectiveDateTime sets the EffectiveDateTime field's value.

func (*PricingPlan) SetPricingMode added in v1.44.139

func (s *PricingPlan) SetPricingMode(v string) *PricingPlan

SetPricingMode sets the PricingMode field's value.

func (*PricingPlan) SetUpdateDateTime added in v1.44.139

func (s *PricingPlan) SetUpdateDateTime(v time.Time) *PricingPlan

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*PricingPlan) SetUpdateReason added in v1.44.139

func (s *PricingPlan) SetUpdateReason(v string) *PricingPlan

SetUpdateReason sets the UpdateReason field's value.

func (PricingPlan) String added in v1.44.139

func (s PricingPlan) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyDefinitionRequest

type PropertyDefinitionRequest struct {

	// A mapping that specifies configuration information about the property. Use
	// this field to specify information that you read from and write to an external
	// source.
	Configuration map[string]*string `locationName:"configuration" type:"map"`

	// An object that contains information about the data type.
	DataType *DataType `locationName:"dataType" type:"structure"`

	// An object that contains the default value.
	DefaultValue *DataValue `locationName:"defaultValue" type:"structure"`

	// A friendly name for the property.
	DisplayName *string `locationName:"displayName" type:"string"`

	// A Boolean value that specifies whether the property ID comes from an external
	// data store.
	IsExternalId *bool `locationName:"isExternalId" type:"boolean"`

	// A Boolean value that specifies whether the property is required.
	IsRequiredInEntity *bool `locationName:"isRequiredInEntity" type:"boolean"`

	// A Boolean value that specifies whether the property is stored externally.
	IsStoredExternally *bool `locationName:"isStoredExternally" type:"boolean"`

	// A Boolean value that specifies whether the property consists of time series
	// data.
	IsTimeSeries *bool `locationName:"isTimeSeries" type:"boolean"`
	// contains filtered or unexported fields
}

An object that sets information about a property.

func (PropertyDefinitionRequest) GoString

func (s PropertyDefinitionRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyDefinitionRequest) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*PropertyDefinitionRequest) SetDataType

SetDataType sets the DataType field's value.

func (*PropertyDefinitionRequest) SetDefaultValue

SetDefaultValue sets the DefaultValue field's value.

func (*PropertyDefinitionRequest) SetDisplayName added in v1.44.156

SetDisplayName sets the DisplayName field's value.

func (*PropertyDefinitionRequest) SetIsExternalId

SetIsExternalId sets the IsExternalId field's value.

func (*PropertyDefinitionRequest) SetIsRequiredInEntity

func (s *PropertyDefinitionRequest) SetIsRequiredInEntity(v bool) *PropertyDefinitionRequest

SetIsRequiredInEntity sets the IsRequiredInEntity field's value.

func (*PropertyDefinitionRequest) SetIsStoredExternally

func (s *PropertyDefinitionRequest) SetIsStoredExternally(v bool) *PropertyDefinitionRequest

SetIsStoredExternally sets the IsStoredExternally field's value.

func (*PropertyDefinitionRequest) SetIsTimeSeries

SetIsTimeSeries sets the IsTimeSeries field's value.

func (PropertyDefinitionRequest) String

func (s PropertyDefinitionRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyDefinitionRequest) Validate

func (s *PropertyDefinitionRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PropertyDefinitionResponse

type PropertyDefinitionResponse struct {

	// A mapping that specifies configuration information about the property.
	Configuration map[string]*string `locationName:"configuration" type:"map"`

	// An object that contains information about the data type.
	//
	// DataType is a required field
	DataType *DataType `locationName:"dataType" type:"structure" required:"true"`

	// An object that contains the default value.
	DefaultValue *DataValue `locationName:"defaultValue" type:"structure"`

	// A friendly name for the property.
	DisplayName *string `locationName:"displayName" type:"string"`

	// A Boolean value that specifies whether the property ID comes from an external
	// data store.
	//
	// IsExternalId is a required field
	IsExternalId *bool `locationName:"isExternalId" type:"boolean" required:"true"`

	// A Boolean value that specifies whether the property definition can be updated.
	//
	// IsFinal is a required field
	IsFinal *bool `locationName:"isFinal" type:"boolean" required:"true"`

	// A Boolean value that specifies whether the property definition is imported
	// from an external data store.
	//
	// IsImported is a required field
	IsImported *bool `locationName:"isImported" type:"boolean" required:"true"`

	// A Boolean value that specifies whether the property definition is inherited
	// from a parent entity.
	//
	// IsInherited is a required field
	IsInherited *bool `locationName:"isInherited" type:"boolean" required:"true"`

	// A Boolean value that specifies whether the property is required in an entity.
	//
	// IsRequiredInEntity is a required field
	IsRequiredInEntity *bool `locationName:"isRequiredInEntity" type:"boolean" required:"true"`

	// A Boolean value that specifies whether the property is stored externally.
	//
	// IsStoredExternally is a required field
	IsStoredExternally *bool `locationName:"isStoredExternally" type:"boolean" required:"true"`

	// A Boolean value that specifies whether the property consists of time series
	// data.
	//
	// IsTimeSeries is a required field
	IsTimeSeries *bool `locationName:"isTimeSeries" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

An object that contains response data from a property definition request.

func (PropertyDefinitionResponse) GoString

func (s PropertyDefinitionResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyDefinitionResponse) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*PropertyDefinitionResponse) SetDataType

SetDataType sets the DataType field's value.

func (*PropertyDefinitionResponse) SetDefaultValue

SetDefaultValue sets the DefaultValue field's value.

func (*PropertyDefinitionResponse) SetDisplayName added in v1.44.156

SetDisplayName sets the DisplayName field's value.

func (*PropertyDefinitionResponse) SetIsExternalId

SetIsExternalId sets the IsExternalId field's value.

func (*PropertyDefinitionResponse) SetIsFinal

SetIsFinal sets the IsFinal field's value.

func (*PropertyDefinitionResponse) SetIsImported

SetIsImported sets the IsImported field's value.

func (*PropertyDefinitionResponse) SetIsInherited

SetIsInherited sets the IsInherited field's value.

func (*PropertyDefinitionResponse) SetIsRequiredInEntity

func (s *PropertyDefinitionResponse) SetIsRequiredInEntity(v bool) *PropertyDefinitionResponse

SetIsRequiredInEntity sets the IsRequiredInEntity field's value.

func (*PropertyDefinitionResponse) SetIsStoredExternally

func (s *PropertyDefinitionResponse) SetIsStoredExternally(v bool) *PropertyDefinitionResponse

SetIsStoredExternally sets the IsStoredExternally field's value.

func (*PropertyDefinitionResponse) SetIsTimeSeries

SetIsTimeSeries sets the IsTimeSeries field's value.

func (PropertyDefinitionResponse) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyFilter

type PropertyFilter struct {

	// The operator associated with this property filter.
	Operator *string `locationName:"operator" min:"1" type:"string"`

	// The property name associated with this property filter.
	PropertyName *string `locationName:"propertyName" min:"1" type:"string"`

	// The value associated with this property filter.
	Value *DataValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

An object that filters items returned by a property request.

func (PropertyFilter) GoString

func (s PropertyFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyFilter) SetOperator

func (s *PropertyFilter) SetOperator(v string) *PropertyFilter

SetOperator sets the Operator field's value.

func (*PropertyFilter) SetPropertyName

func (s *PropertyFilter) SetPropertyName(v string) *PropertyFilter

SetPropertyName sets the PropertyName field's value.

func (*PropertyFilter) SetValue

func (s *PropertyFilter) SetValue(v *DataValue) *PropertyFilter

SetValue sets the Value field's value.

func (PropertyFilter) String

func (s PropertyFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyFilter) Validate

func (s *PropertyFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PropertyGroupRequest added in v1.44.139

type PropertyGroupRequest struct {

	// The group type.
	GroupType *string `locationName:"groupType" type:"string" enum:"GroupType"`

	// The names of properties.
	PropertyNames []*string `locationName:"propertyNames" type:"list"`
	// contains filtered or unexported fields
}

func (PropertyGroupRequest) GoString added in v1.44.139

func (s PropertyGroupRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyGroupRequest) SetGroupType added in v1.44.139

func (s *PropertyGroupRequest) SetGroupType(v string) *PropertyGroupRequest

SetGroupType sets the GroupType field's value.

func (*PropertyGroupRequest) SetPropertyNames added in v1.44.139

func (s *PropertyGroupRequest) SetPropertyNames(v []*string) *PropertyGroupRequest

SetPropertyNames sets the PropertyNames field's value.

func (PropertyGroupRequest) String added in v1.44.139

func (s PropertyGroupRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyGroupResponse added in v1.44.139

type PropertyGroupResponse struct {

	// The group types.
	//
	// GroupType is a required field
	GroupType *string `locationName:"groupType" type:"string" required:"true" enum:"GroupType"`

	// A Boolean value that specifies whether the property group is inherited from
	// a parent entity
	//
	// IsInherited is a required field
	IsInherited *bool `locationName:"isInherited" type:"boolean" required:"true"`

	// The names of properties.
	//
	// PropertyNames is a required field
	PropertyNames []*string `locationName:"propertyNames" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The property group response

func (PropertyGroupResponse) GoString added in v1.44.139

func (s PropertyGroupResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyGroupResponse) SetGroupType added in v1.44.139

SetGroupType sets the GroupType field's value.

func (*PropertyGroupResponse) SetIsInherited added in v1.44.139

func (s *PropertyGroupResponse) SetIsInherited(v bool) *PropertyGroupResponse

SetIsInherited sets the IsInherited field's value.

func (*PropertyGroupResponse) SetPropertyNames added in v1.44.139

func (s *PropertyGroupResponse) SetPropertyNames(v []*string) *PropertyGroupResponse

SetPropertyNames sets the PropertyNames field's value.

func (PropertyGroupResponse) String added in v1.44.139

func (s PropertyGroupResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyLatestValue

type PropertyLatestValue struct {

	// An object that specifies information about a property.
	//
	// PropertyReference is a required field
	PropertyReference *EntityPropertyReference `locationName:"propertyReference" type:"structure" required:"true"`

	// The value of the property.
	PropertyValue *DataValue `locationName:"propertyValue" type:"structure"`
	// contains filtered or unexported fields
}

The latest value of the property.

func (PropertyLatestValue) GoString

func (s PropertyLatestValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyLatestValue) SetPropertyReference

SetPropertyReference sets the PropertyReference field's value.

func (*PropertyLatestValue) SetPropertyValue

func (s *PropertyLatestValue) SetPropertyValue(v *DataValue) *PropertyLatestValue

SetPropertyValue sets the PropertyValue field's value.

func (PropertyLatestValue) String

func (s PropertyLatestValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyRequest

type PropertyRequest struct {

	// An object that specifies information about a property.
	Definition *PropertyDefinitionRequest `locationName:"definition" type:"structure"`

	// The update type of the update property request.
	UpdateType *string `locationName:"updateType" type:"string" enum:"PropertyUpdateType"`

	// The value of the property.
	Value *DataValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

An object that sets information about a property.

func (PropertyRequest) GoString

func (s PropertyRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyRequest) SetDefinition

SetDefinition sets the Definition field's value.

func (*PropertyRequest) SetUpdateType

func (s *PropertyRequest) SetUpdateType(v string) *PropertyRequest

SetUpdateType sets the UpdateType field's value.

func (*PropertyRequest) SetValue

func (s *PropertyRequest) SetValue(v *DataValue) *PropertyRequest

SetValue sets the Value field's value.

func (PropertyRequest) String

func (s PropertyRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyRequest) Validate

func (s *PropertyRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PropertyResponse

type PropertyResponse struct {

	// An object that specifies information about a property.
	Definition *PropertyDefinitionResponse `locationName:"definition" type:"structure"`

	// The value of the property.
	Value *DataValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

An object that contains information about a property response.

func (PropertyResponse) GoString

func (s PropertyResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyResponse) SetDefinition

SetDefinition sets the Definition field's value.

func (*PropertyResponse) SetValue

func (s *PropertyResponse) SetValue(v *DataValue) *PropertyResponse

SetValue sets the Value field's value.

func (PropertyResponse) String

func (s PropertyResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyValue

type PropertyValue struct {

	// ISO8601 DateTime of a value for a time series property.
	//
	// The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].
	//
	//    * [YYYY]: year
	//
	//    * [MM]: month
	//
	//    * [DD]: day
	//
	//    * [hh]: hour
	//
	//    * [mm]: minute
	//
	//    * [ss]: seconds
	//
	//    * [.SSSSSSSSS]: additional precision, where precedence is maintained.
	//    For example: [.573123] is equal to 573123000 nanoseconds.
	//
	//    * Z: default timezone UTC
	//
	//    * ± HH:mm: time zone offset in Hours and Minutes.
	//
	// Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
	Time *string `locationName:"time" min:"20" type:"string"`

	// The timestamp of a value for a time series property.
	//
	// Deprecated: This field is deprecated and will throw an error in the future. Use time instead.
	Timestamp *time.Time `locationName:"timestamp" deprecated:"true" type:"timestamp"`

	// An object that specifies a value for a time series property.
	//
	// Value is a required field
	Value *DataValue `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about a value for a time series property.

func (PropertyValue) GoString

func (s PropertyValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyValue) SetTime added in v1.43.38

func (s *PropertyValue) SetTime(v string) *PropertyValue

SetTime sets the Time field's value.

func (*PropertyValue) SetTimestamp

func (s *PropertyValue) SetTimestamp(v time.Time) *PropertyValue

SetTimestamp sets the Timestamp field's value.

func (*PropertyValue) SetValue

func (s *PropertyValue) SetValue(v *DataValue) *PropertyValue

SetValue sets the Value field's value.

func (PropertyValue) String

func (s PropertyValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyValue) Validate

func (s *PropertyValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PropertyValueEntry

type PropertyValueEntry struct {

	// An object that contains information about the entity that has the property.
	//
	// EntityPropertyReference is a required field
	EntityPropertyReference *EntityPropertyReference `locationName:"entityPropertyReference" type:"structure" required:"true"`

	// A list of objects that specify time series property values.
	PropertyValues []*PropertyValue `locationName:"propertyValues" min:"1" type:"list"`
	// contains filtered or unexported fields
}

An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html) action.

func (PropertyValueEntry) GoString

func (s PropertyValueEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyValueEntry) SetEntityPropertyReference

func (s *PropertyValueEntry) SetEntityPropertyReference(v *EntityPropertyReference) *PropertyValueEntry

SetEntityPropertyReference sets the EntityPropertyReference field's value.

func (*PropertyValueEntry) SetPropertyValues

func (s *PropertyValueEntry) SetPropertyValues(v []*PropertyValue) *PropertyValueEntry

SetPropertyValues sets the PropertyValues field's value.

func (PropertyValueEntry) String

func (s PropertyValueEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyValueEntry) Validate

func (s *PropertyValueEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PropertyValueHistory

type PropertyValueHistory struct {

	// An object that uniquely identifies an entity property.
	//
	// EntityPropertyReference is a required field
	EntityPropertyReference *EntityPropertyReference `locationName:"entityPropertyReference" type:"structure" required:"true"`

	// A list of objects that contain information about the values in the history
	// of a time series property.
	Values []*PropertyValue `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

The history of values for a time series property.

func (PropertyValueHistory) GoString

func (s PropertyValueHistory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyValueHistory) SetEntityPropertyReference

func (s *PropertyValueHistory) SetEntityPropertyReference(v *EntityPropertyReference) *PropertyValueHistory

SetEntityPropertyReference sets the EntityPropertyReference field's value.

func (*PropertyValueHistory) SetValues

SetValues sets the Values field's value.

func (PropertyValueHistory) String

func (s PropertyValueHistory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryTimeoutException added in v1.44.139

type QueryTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The query timeout exception.

func (*QueryTimeoutException) Code added in v1.44.139

func (s *QueryTimeoutException) Code() string

Code returns the exception type name.

func (*QueryTimeoutException) Error added in v1.44.139

func (s *QueryTimeoutException) Error() string

func (QueryTimeoutException) GoString added in v1.44.139

func (s QueryTimeoutException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryTimeoutException) Message added in v1.44.139

func (s *QueryTimeoutException) Message() string

Message returns the exception's message.

func (*QueryTimeoutException) OrigErr added in v1.44.139

func (s *QueryTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*QueryTimeoutException) RequestID added in v1.44.139

func (s *QueryTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*QueryTimeoutException) StatusCode added in v1.44.139

func (s *QueryTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (QueryTimeoutException) String added in v1.44.139

func (s QueryTimeoutException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Relationship

type Relationship struct {

	// The type of the relationship.
	RelationshipType *string `locationName:"relationshipType" min:"1" type:"string"`

	// The ID of the target component type associated with this relationship.
	TargetComponentTypeId *string `locationName:"targetComponentTypeId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that specifies a relationship with another component type.

func (Relationship) GoString

func (s Relationship) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relationship) SetRelationshipType

func (s *Relationship) SetRelationshipType(v string) *Relationship

SetRelationshipType sets the RelationshipType field's value.

func (*Relationship) SetTargetComponentTypeId

func (s *Relationship) SetTargetComponentTypeId(v string) *Relationship

SetTargetComponentTypeId sets the TargetComponentTypeId field's value.

func (Relationship) String

func (s Relationship) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relationship) Validate

func (s *Relationship) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RelationshipValue

type RelationshipValue struct {

	// The name of the target component associated with the relationship value.
	TargetComponentName *string `locationName:"targetComponentName" min:"1" type:"string"`

	// The ID of the target entity associated with this relationship value.
	TargetEntityId *string `locationName:"targetEntityId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A value that associates a component and an entity.

func (RelationshipValue) GoString

func (s RelationshipValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationshipValue) SetTargetComponentName

func (s *RelationshipValue) SetTargetComponentName(v string) *RelationshipValue

SetTargetComponentName sets the TargetComponentName field's value.

func (*RelationshipValue) SetTargetEntityId

func (s *RelationshipValue) SetTargetEntityId(v string) *RelationshipValue

SetTargetEntityId sets the TargetEntityId field's value.

func (RelationshipValue) String

func (s RelationshipValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationshipValue) Validate

func (s *RelationshipValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource wasn't found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Row added in v1.44.139

type Row struct {
	// contains filtered or unexported fields
}

Represents a single row in the query results.

func (Row) GoString added in v1.44.139

func (s Row) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (Row) String added in v1.44.139

func (s Row) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SceneError added in v1.44.256

type SceneError struct {

	// The SceneError code.
	Code *string `locationName:"code" type:"string" enum:"SceneErrorCode"`

	// The SceneError message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The scene error.

func (SceneError) GoString added in v1.44.256

func (s SceneError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SceneError) SetCode added in v1.44.256

func (s *SceneError) SetCode(v string) *SceneError

SetCode sets the Code field's value.

func (*SceneError) SetMessage added in v1.44.256

func (s *SceneError) SetMessage(v string) *SceneError

SetMessage sets the Message field's value.

func (SceneError) String added in v1.44.256

func (s SceneError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SceneSummary

type SceneSummary struct {

	// The ARN of the scene.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The relative path that specifies the location of the content definition file.
	//
	// ContentLocation is a required field
	ContentLocation *string `locationName:"contentLocation" type:"string" required:"true"`

	// The date and time when the scene was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The scene description.
	Description *string `locationName:"description" type:"string"`

	// The ID of the scene.
	//
	// SceneId is a required field
	SceneId *string `locationName:"sceneId" min:"1" type:"string" required:"true"`

	// The date and time when the scene was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about a scene.

func (SceneSummary) GoString

func (s SceneSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SceneSummary) SetArn

func (s *SceneSummary) SetArn(v string) *SceneSummary

SetArn sets the Arn field's value.

func (*SceneSummary) SetContentLocation

func (s *SceneSummary) SetContentLocation(v string) *SceneSummary

SetContentLocation sets the ContentLocation field's value.

func (*SceneSummary) SetCreationDateTime

func (s *SceneSummary) SetCreationDateTime(v time.Time) *SceneSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*SceneSummary) SetDescription

func (s *SceneSummary) SetDescription(v string) *SceneSummary

SetDescription sets the Description field's value.

func (*SceneSummary) SetSceneId

func (s *SceneSummary) SetSceneId(v string) *SceneSummary

SetSceneId sets the SceneId field's value.

func (*SceneSummary) SetUpdateDateTime

func (s *SceneSummary) SetUpdateDateTime(v time.Time) *SceneSummary

SetUpdateDateTime sets the UpdateDateTime field's value.

func (SceneSummary) String

func (s SceneSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service quota was exceeded.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Status

type Status struct {

	// The error message.
	Error *ErrorDetails `locationName:"error" type:"structure"`

	// The current state of the entity, component, component type, or workspace.
	State *string `locationName:"state" type:"string" enum:"State"`
	// contains filtered or unexported fields
}

An object that represents the status of an entity, component, component type, or workspace.

func (Status) GoString

func (s Status) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Status) SetError

func (s *Status) SetError(v *ErrorDetails) *Status

SetError sets the Error field's value.

func (*Status) SetState

func (s *Status) SetState(v string) *Status

SetState sets the State field's value.

func (Status) String

func (s Status) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SyncJobStatus added in v1.44.156

type SyncJobStatus struct {

	// The SyncJob error.
	Error *ErrorDetails `locationName:"error" type:"structure"`

	// The SyncJob status state.
	State *string `locationName:"state" type:"string" enum:"SyncJobState"`
	// contains filtered or unexported fields
}

The SyncJob status.

func (SyncJobStatus) GoString added in v1.44.156

func (s SyncJobStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncJobStatus) SetError added in v1.44.156

func (s *SyncJobStatus) SetError(v *ErrorDetails) *SyncJobStatus

SetError sets the Error field's value.

func (*SyncJobStatus) SetState added in v1.44.156

func (s *SyncJobStatus) SetState(v string) *SyncJobStatus

SetState sets the State field's value.

func (SyncJobStatus) String added in v1.44.156

func (s SyncJobStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SyncJobSummary added in v1.44.156

type SyncJobSummary struct {

	// The SyncJob summary ARN.
	Arn *string `locationName:"arn" min:"20" type:"string"`

	// The creation date and time.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The SyncJob summaries status.
	Status *SyncJobStatus `locationName:"status" type:"structure"`

	// The sync source.
	SyncSource *string `locationName:"syncSource" type:"string"`

	// The update date and time.
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp"`

	// The ID of the workspace that contains the sync job.
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The SyncJob summary.

func (SyncJobSummary) GoString added in v1.44.156

func (s SyncJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncJobSummary) SetArn added in v1.44.156

func (s *SyncJobSummary) SetArn(v string) *SyncJobSummary

SetArn sets the Arn field's value.

func (*SyncJobSummary) SetCreationDateTime added in v1.44.156

func (s *SyncJobSummary) SetCreationDateTime(v time.Time) *SyncJobSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*SyncJobSummary) SetStatus added in v1.44.156

func (s *SyncJobSummary) SetStatus(v *SyncJobStatus) *SyncJobSummary

SetStatus sets the Status field's value.

func (*SyncJobSummary) SetSyncSource added in v1.44.156

func (s *SyncJobSummary) SetSyncSource(v string) *SyncJobSummary

SetSyncSource sets the SyncSource field's value.

func (*SyncJobSummary) SetUpdateDateTime added in v1.44.156

func (s *SyncJobSummary) SetUpdateDateTime(v time.Time) *SyncJobSummary

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*SyncJobSummary) SetWorkspaceId added in v1.44.156

func (s *SyncJobSummary) SetWorkspaceId(v string) *SyncJobSummary

SetWorkspaceId sets the WorkspaceId field's value.

func (SyncJobSummary) String added in v1.44.156

func (s SyncJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SyncResourceFilter added in v1.44.156

type SyncResourceFilter struct {

	// The external ID.
	ExternalId *string `locationName:"externalId" min:"1" type:"string"`

	// The sync resource filter resource ID.
	ResourceId *string `locationName:"resourceId" min:"1" type:"string"`

	// The sync resource filter resource type
	ResourceType *string `locationName:"resourceType" type:"string" enum:"SyncResourceType"`

	// The sync resource filter's state.
	State *string `locationName:"state" type:"string" enum:"SyncResourceState"`
	// contains filtered or unexported fields
}

The sync resource filter.

func (SyncResourceFilter) GoString added in v1.44.156

func (s SyncResourceFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncResourceFilter) SetExternalId added in v1.44.156

func (s *SyncResourceFilter) SetExternalId(v string) *SyncResourceFilter

SetExternalId sets the ExternalId field's value.

func (*SyncResourceFilter) SetResourceId added in v1.44.156

func (s *SyncResourceFilter) SetResourceId(v string) *SyncResourceFilter

SetResourceId sets the ResourceId field's value.

func (*SyncResourceFilter) SetResourceType added in v1.44.156

func (s *SyncResourceFilter) SetResourceType(v string) *SyncResourceFilter

SetResourceType sets the ResourceType field's value.

func (*SyncResourceFilter) SetState added in v1.44.156

SetState sets the State field's value.

func (SyncResourceFilter) String added in v1.44.156

func (s SyncResourceFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncResourceFilter) Validate added in v1.44.156

func (s *SyncResourceFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SyncResourceStatus added in v1.44.156

type SyncResourceStatus struct {

	// The status error.
	Error *ErrorDetails `locationName:"error" type:"structure"`

	// The sync resource status state.
	State *string `locationName:"state" type:"string" enum:"SyncResourceState"`
	// contains filtered or unexported fields
}

The sync resource status.

func (SyncResourceStatus) GoString added in v1.44.156

func (s SyncResourceStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncResourceStatus) SetError added in v1.44.156

SetError sets the Error field's value.

func (*SyncResourceStatus) SetState added in v1.44.156

SetState sets the State field's value.

func (SyncResourceStatus) String added in v1.44.156

func (s SyncResourceStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SyncResourceSummary added in v1.44.156

type SyncResourceSummary struct {

	// The external ID.
	ExternalId *string `locationName:"externalId" min:"1" type:"string"`

	// The resource ID.
	ResourceId *string `locationName:"resourceId" min:"1" type:"string"`

	// The resource type.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"SyncResourceType"`

	// The sync resource summary status.
	Status *SyncResourceStatus `locationName:"status" type:"structure"`

	// The update date and time.
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp"`
	// contains filtered or unexported fields
}

The sync resource summary.

func (SyncResourceSummary) GoString added in v1.44.156

func (s SyncResourceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncResourceSummary) SetExternalId added in v1.44.156

func (s *SyncResourceSummary) SetExternalId(v string) *SyncResourceSummary

SetExternalId sets the ExternalId field's value.

func (*SyncResourceSummary) SetResourceId added in v1.44.156

func (s *SyncResourceSummary) SetResourceId(v string) *SyncResourceSummary

SetResourceId sets the ResourceId field's value.

func (*SyncResourceSummary) SetResourceType added in v1.44.156

func (s *SyncResourceSummary) SetResourceType(v string) *SyncResourceSummary

SetResourceType sets the ResourceType field's value.

func (*SyncResourceSummary) SetStatus added in v1.44.156

SetStatus sets the Status field's value.

func (*SyncResourceSummary) SetUpdateDateTime added in v1.44.156

func (s *SyncResourceSummary) SetUpdateDateTime(v time.Time) *SyncResourceSummary

SetUpdateDateTime sets the UpdateDateTime field's value.

func (SyncResourceSummary) String added in v1.44.156

func (s SyncResourceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TabularConditions added in v1.44.139

type TabularConditions struct {

	// Filter criteria that orders the output. It can be sorted in ascending or
	// descending order.
	OrderBy []*OrderBy `locationName:"orderBy" min:"1" type:"list"`

	// You can filter the request using various logical operators and a key-value
	// format. For example:
	//
	// {"key": "serverType", "value": "webServer"}
	PropertyFilters []*PropertyFilter `locationName:"propertyFilters" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The tabular conditions.

func (TabularConditions) GoString added in v1.44.139

func (s TabularConditions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TabularConditions) SetOrderBy added in v1.44.139

func (s *TabularConditions) SetOrderBy(v []*OrderBy) *TabularConditions

SetOrderBy sets the OrderBy field's value.

func (*TabularConditions) SetPropertyFilters added in v1.44.139

func (s *TabularConditions) SetPropertyFilters(v []*PropertyFilter) *TabularConditions

SetPropertyFilters sets the PropertyFilters field's value.

func (TabularConditions) String added in v1.44.139

func (s TabularConditions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TabularConditions) Validate added in v1.44.139

func (s *TabularConditions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceARN is a required field
	ResourceARN *string `locationName:"resourceARN" min:"20" type:"string" required:"true"`

	// Metadata to add to this resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The rate exceeds the limit.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTagsException

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The number of tags exceeds the limit.

func (*TooManyTagsException) Code

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"querystring" locationName:"resourceARN" min:"20" type:"string" required:"true"`

	// A list of tag key names to remove from the resource. You don't specify the
	// value. Both the key and its associated value are removed.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateComponentTypeInput

type UpdateComponentTypeInput struct {

	// The ID of the component type.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `location:"uri" locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// The component type name.
	ComponentTypeName *string `locationName:"componentTypeName" type:"string"`

	// The description of the component type.
	Description *string `locationName:"description" type:"string"`

	// Specifies the component type that this component type extends.
	ExtendsFrom []*string `locationName:"extendsFrom" type:"list"`

	// An object that maps strings to the functions in the component type. Each
	// string in the mapping must be unique to this object.
	Functions map[string]*FunctionRequest `locationName:"functions" type:"map"`

	// A Boolean value that specifies whether an entity can have more than one component
	// of this type.
	IsSingleton *bool `locationName:"isSingleton" type:"boolean"`

	// An object that maps strings to the property definitions in the component
	// type. Each string in the mapping must be unique to this object.
	PropertyDefinitions map[string]*PropertyDefinitionRequest `locationName:"propertyDefinitions" type:"map"`

	// The property groups.
	PropertyGroups map[string]*PropertyGroupRequest `locationName:"propertyGroups" type:"map"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateComponentTypeInput) GoString

func (s UpdateComponentTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentTypeInput) SetComponentTypeId

func (s *UpdateComponentTypeInput) SetComponentTypeId(v string) *UpdateComponentTypeInput

SetComponentTypeId sets the ComponentTypeId field's value.

func (*UpdateComponentTypeInput) SetComponentTypeName added in v1.44.156

func (s *UpdateComponentTypeInput) SetComponentTypeName(v string) *UpdateComponentTypeInput

SetComponentTypeName sets the ComponentTypeName field's value.

func (*UpdateComponentTypeInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateComponentTypeInput) SetExtendsFrom

func (s *UpdateComponentTypeInput) SetExtendsFrom(v []*string) *UpdateComponentTypeInput

SetExtendsFrom sets the ExtendsFrom field's value.

func (*UpdateComponentTypeInput) SetFunctions

SetFunctions sets the Functions field's value.

func (*UpdateComponentTypeInput) SetIsSingleton

SetIsSingleton sets the IsSingleton field's value.

func (*UpdateComponentTypeInput) SetPropertyDefinitions

SetPropertyDefinitions sets the PropertyDefinitions field's value.

func (*UpdateComponentTypeInput) SetPropertyGroups added in v1.44.139

SetPropertyGroups sets the PropertyGroups field's value.

func (*UpdateComponentTypeInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateComponentTypeInput) String

func (s UpdateComponentTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentTypeInput) Validate

func (s *UpdateComponentTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateComponentTypeOutput

type UpdateComponentTypeOutput struct {

	// The ARN of the component type.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The ID of the component type.
	//
	// ComponentTypeId is a required field
	ComponentTypeId *string `locationName:"componentTypeId" min:"1" type:"string" required:"true"`

	// The current state of the component type.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`

	// The ID of the workspace that contains the component type.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateComponentTypeOutput) GoString

func (s UpdateComponentTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateComponentTypeOutput) SetArn

SetArn sets the Arn field's value.

func (*UpdateComponentTypeOutput) SetComponentTypeId

SetComponentTypeId sets the ComponentTypeId field's value.

func (*UpdateComponentTypeOutput) SetState

SetState sets the State field's value.

func (*UpdateComponentTypeOutput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateComponentTypeOutput) String

func (s UpdateComponentTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateEntityInput

type UpdateEntityInput struct {

	// An object that maps strings to the component updates in the request. Each
	// string in the mapping must be unique to this object.
	ComponentUpdates map[string]*ComponentUpdateRequest `locationName:"componentUpdates" type:"map"`

	// The description of the entity.
	Description *string `locationName:"description" type:"string"`

	// The ID of the entity.
	//
	// EntityId is a required field
	EntityId *string `location:"uri" locationName:"entityId" min:"1" type:"string" required:"true"`

	// The name of the entity.
	EntityName *string `locationName:"entityName" min:"1" type:"string"`

	// An object that describes the update request for a parent entity.
	ParentEntityUpdate *ParentEntityUpdateRequest `locationName:"parentEntityUpdate" type:"structure"`

	// The ID of the workspace that contains the entity.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEntityInput) GoString

func (s UpdateEntityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEntityInput) SetComponentUpdates

func (s *UpdateEntityInput) SetComponentUpdates(v map[string]*ComponentUpdateRequest) *UpdateEntityInput

SetComponentUpdates sets the ComponentUpdates field's value.

func (*UpdateEntityInput) SetDescription

func (s *UpdateEntityInput) SetDescription(v string) *UpdateEntityInput

SetDescription sets the Description field's value.

func (*UpdateEntityInput) SetEntityId

func (s *UpdateEntityInput) SetEntityId(v string) *UpdateEntityInput

SetEntityId sets the EntityId field's value.

func (*UpdateEntityInput) SetEntityName

func (s *UpdateEntityInput) SetEntityName(v string) *UpdateEntityInput

SetEntityName sets the EntityName field's value.

func (*UpdateEntityInput) SetParentEntityUpdate

func (s *UpdateEntityInput) SetParentEntityUpdate(v *ParentEntityUpdateRequest) *UpdateEntityInput

SetParentEntityUpdate sets the ParentEntityUpdate field's value.

func (*UpdateEntityInput) SetWorkspaceId

func (s *UpdateEntityInput) SetWorkspaceId(v string) *UpdateEntityInput

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateEntityInput) String

func (s UpdateEntityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEntityInput) Validate

func (s *UpdateEntityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEntityOutput

type UpdateEntityOutput struct {

	// The current state of the entity update.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`

	// The date and time when the entity was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEntityOutput) GoString

func (s UpdateEntityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEntityOutput) SetState

SetState sets the State field's value.

func (*UpdateEntityOutput) SetUpdateDateTime

func (s *UpdateEntityOutput) SetUpdateDateTime(v time.Time) *UpdateEntityOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (UpdateEntityOutput) String

func (s UpdateEntityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdatePricingPlanInput added in v1.44.139

type UpdatePricingPlanInput struct {

	// The bundle names.
	BundleNames []*string `locationName:"bundleNames" min:"1" type:"list"`

	// The pricing mode.
	//
	// PricingMode is a required field
	PricingMode *string `locationName:"pricingMode" type:"string" required:"true" enum:"PricingMode"`
	// contains filtered or unexported fields
}

func (UpdatePricingPlanInput) GoString added in v1.44.139

func (s UpdatePricingPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePricingPlanInput) SetBundleNames added in v1.44.139

func (s *UpdatePricingPlanInput) SetBundleNames(v []*string) *UpdatePricingPlanInput

SetBundleNames sets the BundleNames field's value.

func (*UpdatePricingPlanInput) SetPricingMode added in v1.44.139

SetPricingMode sets the PricingMode field's value.

func (UpdatePricingPlanInput) String added in v1.44.139

func (s UpdatePricingPlanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePricingPlanInput) Validate added in v1.44.139

func (s *UpdatePricingPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePricingPlanOutput added in v1.44.139

type UpdatePricingPlanOutput struct {

	// Update the current pricing plan.
	//
	// CurrentPricingPlan is a required field
	CurrentPricingPlan *PricingPlan `locationName:"currentPricingPlan" type:"structure" required:"true"`

	// Update the pending pricing plan.
	PendingPricingPlan *PricingPlan `locationName:"pendingPricingPlan" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdatePricingPlanOutput) GoString added in v1.44.139

func (s UpdatePricingPlanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePricingPlanOutput) SetCurrentPricingPlan added in v1.44.139

func (s *UpdatePricingPlanOutput) SetCurrentPricingPlan(v *PricingPlan) *UpdatePricingPlanOutput

SetCurrentPricingPlan sets the CurrentPricingPlan field's value.

func (*UpdatePricingPlanOutput) SetPendingPricingPlan added in v1.44.139

func (s *UpdatePricingPlanOutput) SetPendingPricingPlan(v *PricingPlan) *UpdatePricingPlanOutput

SetPendingPricingPlan sets the PendingPricingPlan field's value.

func (UpdatePricingPlanOutput) String added in v1.44.139

func (s UpdatePricingPlanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSceneInput

type UpdateSceneInput struct {

	// A list of capabilities that the scene uses to render.
	Capabilities []*string `locationName:"capabilities" type:"list"`

	// The relative path that specifies the location of the content definition file.
	ContentLocation *string `locationName:"contentLocation" type:"string"`

	// The description of this scene.
	Description *string `locationName:"description" type:"string"`

	// The ID of the scene.
	//
	// SceneId is a required field
	SceneId *string `location:"uri" locationName:"sceneId" min:"1" type:"string" required:"true"`

	// The scene metadata.
	SceneMetadata map[string]*string `locationName:"sceneMetadata" type:"map"`

	// The ID of the workspace that contains the scene.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSceneInput) GoString

func (s UpdateSceneInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSceneInput) SetCapabilities

func (s *UpdateSceneInput) SetCapabilities(v []*string) *UpdateSceneInput

SetCapabilities sets the Capabilities field's value.

func (*UpdateSceneInput) SetContentLocation

func (s *UpdateSceneInput) SetContentLocation(v string) *UpdateSceneInput

SetContentLocation sets the ContentLocation field's value.

func (*UpdateSceneInput) SetDescription

func (s *UpdateSceneInput) SetDescription(v string) *UpdateSceneInput

SetDescription sets the Description field's value.

func (*UpdateSceneInput) SetSceneId

func (s *UpdateSceneInput) SetSceneId(v string) *UpdateSceneInput

SetSceneId sets the SceneId field's value.

func (*UpdateSceneInput) SetSceneMetadata added in v1.44.227

func (s *UpdateSceneInput) SetSceneMetadata(v map[string]*string) *UpdateSceneInput

SetSceneMetadata sets the SceneMetadata field's value.

func (*UpdateSceneInput) SetWorkspaceId

func (s *UpdateSceneInput) SetWorkspaceId(v string) *UpdateSceneInput

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateSceneInput) String

func (s UpdateSceneInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSceneInput) Validate

func (s *UpdateSceneInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSceneOutput

type UpdateSceneOutput struct {

	// The date and time when the scene was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSceneOutput) GoString

func (s UpdateSceneOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSceneOutput) SetUpdateDateTime

func (s *UpdateSceneOutput) SetUpdateDateTime(v time.Time) *UpdateSceneOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (UpdateSceneOutput) String

func (s UpdateSceneOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceInput

type UpdateWorkspaceInput struct {

	// The description of the workspace.
	Description *string `locationName:"description" type:"string"`

	// The ARN of the execution role associated with the workspace.
	Role *string `locationName:"role" min:"20" type:"string"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceInput) GoString

func (s UpdateWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceInput) SetDescription

func (s *UpdateWorkspaceInput) SetDescription(v string) *UpdateWorkspaceInput

SetDescription sets the Description field's value.

func (*UpdateWorkspaceInput) SetRole

SetRole sets the Role field's value.

func (*UpdateWorkspaceInput) SetWorkspaceId

func (s *UpdateWorkspaceInput) SetWorkspaceId(v string) *UpdateWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateWorkspaceInput) String

func (s UpdateWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceInput) Validate

func (s *UpdateWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkspaceOutput

type UpdateWorkspaceOutput struct {

	// The date and time of the current update.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceOutput) GoString

func (s UpdateWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceOutput) SetUpdateDateTime

func (s *UpdateWorkspaceOutput) SetUpdateDateTime(v time.Time) *UpdateWorkspaceOutput

SetUpdateDateTime sets the UpdateDateTime field's value.

func (UpdateWorkspaceOutput) String

func (s UpdateWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Failed

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceSummary

type WorkspaceSummary struct {

	// The ARN of the workspace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"20" type:"string" required:"true"`

	// The date and time when the workspace was created.
	//
	// CreationDateTime is a required field
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp" required:"true"`

	// The description of the workspace.
	Description *string `locationName:"description" type:"string"`

	// The date and time when the workspace was last updated.
	//
	// UpdateDateTime is a required field
	UpdateDateTime *time.Time `locationName:"updateDateTime" type:"timestamp" required:"true"`

	// The ID of the workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about a workspace.

func (WorkspaceSummary) GoString

func (s WorkspaceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceSummary) SetArn

SetArn sets the Arn field's value.

func (*WorkspaceSummary) SetCreationDateTime

func (s *WorkspaceSummary) SetCreationDateTime(v time.Time) *WorkspaceSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*WorkspaceSummary) SetDescription

func (s *WorkspaceSummary) SetDescription(v string) *WorkspaceSummary

SetDescription sets the Description field's value.

func (*WorkspaceSummary) SetUpdateDateTime

func (s *WorkspaceSummary) SetUpdateDateTime(v time.Time) *WorkspaceSummary

SetUpdateDateTime sets the UpdateDateTime field's value.

func (*WorkspaceSummary) SetWorkspaceId

func (s *WorkspaceSummary) SetWorkspaceId(v string) *WorkspaceSummary

SetWorkspaceId sets the WorkspaceId field's value.

func (WorkspaceSummary) String

func (s WorkspaceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package iottwinmakeriface provides an interface to enable mocking the AWS IoT TwinMaker service client for testing your code.
Package iottwinmakeriface provides an interface to enable mocking the AWS IoT TwinMaker service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL