Class: Aws::DirectoryService::Types::DescribeTrustsRequest

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 DescribeTrustsRequest data as a hash:

{
  directory_id: "DirectoryId",
  trust_ids: ["TrustId"],
  next_token: "NextToken",
  limit: 1,
}

Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.

Returns:

  • (String)


2124
2125
2126
2127
2128
2129
2130
2131
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2124

class DescribeTrustsRequest < Struct.new(
  :directory_id,
  :trust_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#limitInteger

The maximum number of objects to return.

Returns:

  • (Integer)


2124
2125
2126
2127
2128
2129
2130
2131
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2124

class DescribeTrustsRequest < Struct.new(
  :directory_id,
  :trust_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


2124
2125
2126
2127
2128
2129
2130
2131
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2124

class DescribeTrustsRequest < Struct.new(
  :directory_id,
  :trust_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#trust_idsArray<String>

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Returns:

  • (Array<String>)


2124
2125
2126
2127
2128
2129
2130
2131
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2124

class DescribeTrustsRequest < Struct.new(
  :directory_id,
  :trust_ids,
  :next_token,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end