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

Class: Aws::ServiceCatalog::Types::SearchProvisionedProductsInput

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

Overview

Note:

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

{
  accept_language: "AcceptLanguage",
  access_level_filter: {
    key: "Account", # accepts Account, Role, User
    value: "AccessLevelFilterValue",
  },
  filters: {
    "SearchQuery" => ["ProvisionedProductViewFilterValue"],
  },
  sort_by: "SortField",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  page_size: 1,
  page_token: "PageToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Returns:

  • (String)


4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end

#access_level_filterTypes::AccessLevelFilter

The access level to use to obtain results. The default is User.



4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end

#filtersHash<String,Array<String>>

The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, and userArnSession.

Example: "SearchQuery":["status:AVAILABLE"]

Returns:

  • (Hash<String,Array<String>>)


4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end

#page_sizeInteger

The maximum number of items to return with this call.

Returns:

  • (Integer)


4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end

#page_tokenString

The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

  • (String)


4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end

#sort_byString

The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

Returns:

  • (String)


4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end

#sort_orderString

The sort order. If no value is specified, the results are not sorted.

Returns:

  • (String)


4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 4235

class SearchProvisionedProductsInput < Struct.new(
  :accept_language,
  :access_level_filter,
  :filters,
  :sort_by,
  :sort_order,
  :page_size,
  :page_token)
  include Aws::Structure
end