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

Class: Aws::CloudDirectory::Types::ListOutgoingTypedLinksRequest

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

Overview

Note:

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

{
  directory_arn: "Arn", # required
  object_reference: { # required
    selector: "SelectorObjectReference",
  },
  filter_attribute_ranges: [
    {
      attribute_name: "AttributeName",
      range: { # required
        start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
        start_value: {
          string_value: "StringAttributeValue",
          binary_value: "data",
          boolean_value: false,
          number_value: "NumberAttributeValue",
          datetime_value: Time.now,
        },
        end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
        end_value: {
          string_value: "StringAttributeValue",
          binary_value: "data",
          boolean_value: false,
          number_value: "NumberAttributeValue",
          datetime_value: Time.now,
        },
      },
    },
  ],
  filter_typed_link: {
    schema_arn: "Arn", # required
    typed_link_name: "TypedLinkName", # required
  },
  next_token: "NextToken",
  max_results: 1,
  consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
}

Instance Attribute Summary collapse

Instance Attribute Details

#consistency_levelString

The consistency level to execute the request at.

Returns:

  • (String)


5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end

#directory_arnString

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

Returns:

  • (String)


5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end

#filter_attribute_rangesArray<Types::TypedLinkAttributeRange>

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

Returns:



5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.



5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to retrieve.

Returns:

  • (Integer)


5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end

#next_tokenString

The pagination token.

Returns:

  • (String)


5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end

#object_referenceTypes::ObjectReference

A reference that identifies the object whose attributes will be listed.



5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 5321

class ListOutgoingTypedLinksRequest < Struct.new(
  :directory_arn,
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results,
  :consistency_level)
  include Aws::Structure
end