Class: Aws::DirectoryService::Types::DescribeSettingsRequest

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

Overview

Note:

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

{
  directory_id: "DirectoryId", # required
  status: "Requested", # accepts Requested, Updating, Updated, Failed, Default
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

The identifier of the directory for which to retrieve information.

Returns:

  • (String)


1921
1922
1923
1924
1925
1926
1927
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1921

class DescribeSettingsRequest < Struct.new(
  :directory_id,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

Returns:

  • (String)


1921
1922
1923
1924
1925
1926
1927
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1921

class DescribeSettingsRequest < Struct.new(
  :directory_id,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the directory settings for which to retrieve information.

Returns:

  • (String)


1921
1922
1923
1924
1925
1926
1927
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1921

class DescribeSettingsRequest < Struct.new(
  :directory_id,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end