GetInstancesHealthStatusRequest

public struct GetInstancesHealthStatusRequest : AWSShape
extension ServiceDiscovery.GetInstancesHealthStatusRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • An array that contains the IDs of all the instances that you want to get the health status for. If you omit Instances, AWS Cloud Map returns the health status for all the instances that are associated with the specified service. To get the IDs for the instances that you’ve registered by using a specified service, submit a ListInstances request.

    Declaration

    Swift

    public let instances: [String]?
  • The maximum number of instances that you want AWS Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don’t specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.

    Declaration

    Swift

    public let maxResults: Int?
  • For the first GetInstancesHealthStatus request, omit this value. If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    Declaration

    Swift

    public let nextToken: String?
  • The ID of the service that the instance is associated with.

    Declaration

    Swift

    public let serviceId: String
  • Undocumented

    Declaration

    Swift

    public init(instances: [String]? = nil, maxResults: Int? = nil, nextToken: String? = nil, serviceId: String)
  • Declaration

    Swift

    public func validate(name: String) throws