AWSEC2DescribeInstanceStatusRequest

Objective-C

@interface AWSEC2DescribeInstanceStatusRequest

Swift

class AWSEC2DescribeInstanceStatusRequest

  • 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

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2Filter *> *_Nullable filters;

    Swift

    var filters: [AWSEC2Filter]? { get set }

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

    Default: false

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable includeAllInstances;

    Swift

    var includeAllInstances: NSNumber? { get set }

  • The instance IDs.

    Default: Describes all your instances.

    Constraints: Maximum 100 explicitly specified instance IDs.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable instanceIds;

    Swift

    var instanceIds: [String]? { get set }

  • The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

    You cannot specify this parameter and the instance IDs parameter in the same request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxResults;

    Swift

    var maxResults: NSNumber? { get set }

  • The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextToken;

    Swift

    var nextToken: String? { get set }