You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::DescribeMaintenanceWindowScheduleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DescribeMaintenanceWindowScheduleRequest data as a hash:

{
  window_id: "MaintenanceWindowId",
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  resource_type: "INSTANCE", # accepts INSTANCE
  filters: [
    {
      key: "PatchOrchestratorFilterKey",
      values: ["PatchOrchestratorFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::PatchOrchestratorFilter>

Filters used to limit the range of results. For example, you can limit Maintenance Window executions to only those scheduled before or after a certain date and time.

Returns:



4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4649

class DescribeMaintenanceWindowScheduleRequest < Struct.new(
  :window_id,
  :targets,
  :resource_type,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

  • (Integer)


4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4649

class DescribeMaintenanceWindowScheduleRequest < Struct.new(
  :window_id,
  :targets,
  :resource_type,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String)


4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4649

class DescribeMaintenanceWindowScheduleRequest < Struct.new(
  :window_id,
  :targets,
  :resource_type,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#resource_typeString

The type of resource you want to retrieve information about. For example, "INSTANCE".

Returns:

  • (String)


4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4649

class DescribeMaintenanceWindowScheduleRequest < Struct.new(
  :window_id,
  :targets,
  :resource_type,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#targetsArray<Types::Target>

The instance ID or key/value pair to retrieve information about.

Returns:



4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4649

class DescribeMaintenanceWindowScheduleRequest < Struct.new(
  :window_id,
  :targets,
  :resource_type,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#window_idString

The ID of the Maintenance Window to retrieve information about.

Returns:

  • (String)


4649
4650
4651
4652
4653
4654
4655
4656
4657
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4649

class DescribeMaintenanceWindowScheduleRequest < Struct.new(
  :window_id,
  :targets,
  :resource_type,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end