DescribeInstanceStatusRequest

public struct DescribeInstanceStatusRequest : AWSShape
extension EC2.DescribeInstanceStatusRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    Declaration

    Swift

    public let dryRun: Bool?

  • The filters. availability-zone - The Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

    Declaration

    Swift

    public let filters: [Filter]?

  • When true, includes the health status for all instances. When false, includes the health status for running instances only. Default: false

    Declaration

    Swift

    public let includeAllInstances: Bool?

  • The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.

    Declaration

    Swift

    public let instanceIds: [String]?

  • The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

    Declaration

    Swift

    public let maxResults: Int?

  • The token to retrieve the next page of results.

    Declaration

    Swift

    public let nextToken: String?

  • Undocumented

    Declaration

    Swift

    public init(dryRun: Bool? = nil, filters: [Filter]? = nil, includeAllInstances: Bool? = nil, instanceIds: [String]? = nil, maxResults: Int? = nil, nextToken: String? = nil)

Paginators

  • Undocumented

    Declaration

    Swift

    public func usingPaginationToken(_ token: String) -> EC2.DescribeInstanceStatusRequest