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

Class: Aws::CloudDirectory::Types::BatchListOutgoingTypedLinks

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

{
  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,
}

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

Instance Attribute Summary collapse

Instance Attribute Details

#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:



1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1651

class BatchListOutgoingTypedLinks < Struct.new(
  :object_reference,
  :filter_attribute_ranges,
  :filter_typed_link,
  :next_token,
  :max_results)
  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.



1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1651

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

#max_resultsInteger

The maximum number of results to retrieve.

Returns:

  • (Integer)


1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1651

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

#next_tokenString

The pagination token.

Returns:

  • (String)


1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1651

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

#object_referenceTypes::ObjectReference

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



1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 1651

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