Class: Aws::Pipes::Types::ListPipesRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pipes::Types::ListPipesRequest

Defined in:

gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:next_token]

Instance Attribute Summary

• #current_state ⇒ String

  The state the pipe is in.

• #desired_state ⇒ String

  The state the pipe should be in.

• #limit ⇒ Integer

  The maximum number of pipes to include in the response.

• #name_prefix ⇒ String

  A value that will return a subset of the pipes associated with this account.

• #next_token ⇒ String

  If nextToken is returned, there are more results available.

• #source_prefix ⇒ String

  The prefix matching the pipe source.

• #target_prefix ⇒ String

  The prefix matching the pipe target.

Instance Attribute Details

#current_state ⇒ String

The state the pipe is in.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#desired_state ⇒ String

The state the pipe should be in.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of pipes to include in the response.

Returns:

• (Integer)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#name_prefix ⇒ String

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#next_token ⇒ String

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#source_prefix ⇒ String

The prefix matching the pipe source.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#target_prefix ⇒ String

The prefix matching the pipe target.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1218

class ListPipesRequest < Struct.new(
  :name_prefix,
  :desired_state,
  :current_state,
  :source_prefix,
  :target_prefix,
  :next_token,
  :limit)
  SENSITIVE = [:next_token]
  include Aws::Structure
end