ListAssociatedAssetsRequest

public struct ListAssociatedAssetsRequest : AWSShape
extension IoTSiteWise.ListAssociatedAssetsRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The ID of the asset to query.

    Declaration

    Swift

    public let assetId: String

  • The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

    Declaration

    Swift

    public let hierarchyId: String?

  • The maximum number of results to be returned per paginated request. Default: 50

    Declaration

    Swift

    public let maxResults: Int?

  • The token to be used for the next set of paginated results.

    Declaration

    Swift

    public let nextToken: String?

  • The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes the asset’s parent asset. Default: CHILD

    Declaration

    Swift

    public let traversalDirection: TraversalDirection?

  • Undocumented

    Declaration

    Swift

    public init(assetId: String, hierarchyId: String? = nil, maxResults: Int? = nil, nextToken: String? = nil, traversalDirection: TraversalDirection? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws

Paginators