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

Class: Aws::ServerlessApplicationRepository::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



153
154
155
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 153

def initialize(*args)
  super
end

Instance Method Details

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  author: "__string", # required
  description: "__string", # required
  home_page_url: "__string",
  labels: ["__string"],
  license_body: "__string",
  license_url: "__string",
  name: "__string", # required
  readme_body: "__string",
  readme_url: "__string",
  semantic_version: "__string",
  source_code_url: "__string",
  spdx_license_id: "__string",
  template_body: "__string",
  template_url: "__string",
})

Response structure


resp.application_id #=> String
resp.author #=> String
resp.creation_time #=> String
resp.description #=> String
resp.home_page_url #=> String
resp.labels #=> Array
resp.labels[0] #=> String
resp.license_url #=> String
resp.name #=> String
resp.readme_url #=> String
resp.spdx_license_id #=> String
resp.version.application_id #=> String
resp.version.creation_time #=> String
resp.version.parameter_definitions #=> Array
resp.version.parameter_definitions[0].allowed_pattern #=> String
resp.version.parameter_definitions[0].allowed_values #=> Array
resp.version.parameter_definitions[0].allowed_values[0] #=> String
resp.version.parameter_definitions[0].constraint_description #=> String
resp.version.parameter_definitions[0].default_value #=> String
resp.version.parameter_definitions[0].description #=> String
resp.version.parameter_definitions[0].max_length #=> Integer
resp.version.parameter_definitions[0].max_value #=> Integer
resp.version.parameter_definitions[0].min_length #=> Integer
resp.version.parameter_definitions[0].min_value #=> Integer
resp.version.parameter_definitions[0].name #=> String
resp.version.parameter_definitions[0].no_echo #=> Boolean
resp.version.parameter_definitions[0].referenced_by_resources #=> Array
resp.version.parameter_definitions[0].referenced_by_resources[0] #=> String
resp.version.parameter_definitions[0].type #=> String
resp.version.semantic_version #=> String
resp.version.source_code_url #=> String
resp.version.template_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :author (required, String)
  • :description (required, String)
  • :home_page_url (String)
  • :labels (Array<String>)
  • :license_body (String)
  • :license_url (String)
  • :name (required, String)
  • :readme_body (String)
  • :readme_url (String)
  • :semantic_version (String)
  • :source_code_url (String)
  • :spdx_license_id (String)
  • :template_body (String)
  • :template_url (String)

Returns:

See Also:



262
263
264
265
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 262

def create_application(params = {}, options = {})
  req = build_request(:create_application, params)
  req.send_request(options)
end

#create_application_version(params = {}) ⇒ Types::CreateApplicationVersionResponse

Creates an application version.

Examples:

Request syntax with placeholder values


resp = client.create_application_version({
  application_id: "__string", # required
  semantic_version: "__string", # required
  source_code_url: "__string",
  template_body: "__string",
  template_url: "__string",
})

Response structure


resp.application_id #=> String
resp.creation_time #=> String
resp.parameter_definitions #=> Array
resp.parameter_definitions[0].allowed_pattern #=> String
resp.parameter_definitions[0].allowed_values #=> Array
resp.parameter_definitions[0].allowed_values[0] #=> String
resp.parameter_definitions[0].constraint_description #=> String
resp.parameter_definitions[0].default_value #=> String
resp.parameter_definitions[0].description #=> String
resp.parameter_definitions[0].max_length #=> Integer
resp.parameter_definitions[0].max_value #=> Integer
resp.parameter_definitions[0].min_length #=> Integer
resp.parameter_definitions[0].min_value #=> Integer
resp.parameter_definitions[0].name #=> String
resp.parameter_definitions[0].no_echo #=> Boolean
resp.parameter_definitions[0].referenced_by_resources #=> Array
resp.parameter_definitions[0].referenced_by_resources[0] #=> String
resp.parameter_definitions[0].type #=> String
resp.semantic_version #=> String
resp.source_code_url #=> String
resp.template_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :semantic_version (required, String)
  • :source_code_url (String)
  • :template_body (String)
  • :template_url (String)

Returns:

See Also:



326
327
328
329
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 326

def create_application_version(params = {}, options = {})
  req = build_request(:create_application_version, params)
  req.send_request(options)
end

#create_cloud_formation_change_set(params = {}) ⇒ Types::CreateCloudFormationChangeSetResponse

Creates an AWS CloudFormation change set for the given application.

Examples:

Request syntax with placeholder values


resp = client.create_cloud_formation_change_set({
  application_id: "__string", # required
  parameter_overrides: [
    {
      name: "__string", # required
      value: "__string", # required
    },
  ],
  semantic_version: "__string",
  stack_name: "__string", # required
})

Response structure


resp.application_id #=> String
resp.change_set_id #=> String
resp.semantic_version #=> String
resp.stack_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :parameter_overrides (Array<Types::ParameterValue>)
  • :semantic_version (String)
  • :stack_name (required, String)

Returns:

See Also:



373
374
375
376
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 373

def create_cloud_formation_change_set(params = {}, options = {})
  req = build_request(:create_cloud_formation_change_set, params)
  req.send_request(options)
end

#delete_application(params = {}) ⇒ Struct

Deletes the specified application.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  application_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



394
395
396
397
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 394

def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
end

#get_application(params = {}) ⇒ Types::GetApplicationResponse

Gets the specified application.

Examples:

Request syntax with placeholder values


resp = client.get_application({
  application_id: "__string", # required
  semantic_version: "__string",
})

Response structure


resp.application_id #=> String
resp.author #=> String
resp.creation_time #=> String
resp.description #=> String
resp.home_page_url #=> String
resp.labels #=> Array
resp.labels[0] #=> String
resp.license_url #=> String
resp.name #=> String
resp.readme_url #=> String
resp.spdx_license_id #=> String
resp.version.application_id #=> String
resp.version.creation_time #=> String
resp.version.parameter_definitions #=> Array
resp.version.parameter_definitions[0].allowed_pattern #=> String
resp.version.parameter_definitions[0].allowed_values #=> Array
resp.version.parameter_definitions[0].allowed_values[0] #=> String
resp.version.parameter_definitions[0].constraint_description #=> String
resp.version.parameter_definitions[0].default_value #=> String
resp.version.parameter_definitions[0].description #=> String
resp.version.parameter_definitions[0].max_length #=> Integer
resp.version.parameter_definitions[0].max_value #=> Integer
resp.version.parameter_definitions[0].min_length #=> Integer
resp.version.parameter_definitions[0].min_value #=> Integer
resp.version.parameter_definitions[0].name #=> String
resp.version.parameter_definitions[0].no_echo #=> Boolean
resp.version.parameter_definitions[0].referenced_by_resources #=> Array
resp.version.parameter_definitions[0].referenced_by_resources[0] #=> String
resp.version.parameter_definitions[0].type #=> String
resp.version.semantic_version #=> String
resp.version.source_code_url #=> String
resp.version.template_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :semantic_version (String)

Returns:

See Also:



465
466
467
468
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 465

def get_application(params = {}, options = {})
  req = build_request(:get_application, params)
  req.send_request(options)
end

#get_application_policy(params = {}) ⇒ Types::GetApplicationPolicyResponse

Retrieves the policy for the application.

Examples:

Request syntax with placeholder values


resp = client.get_application_policy({
  application_id: "__string", # required
})

Response structure


resp.statements #=> Array
resp.statements[0].actions #=> Array
resp.statements[0].actions[0] #=> String
resp.statements[0].principals #=> Array
resp.statements[0].principals[0] #=> String
resp.statements[0].statement_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)

Returns:

See Also:



497
498
499
500
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 497

def get_application_policy(params = {}, options = {})
  req = build_request(:get_application_policy, params)
  req.send_request(options)
end

#list_application_versions(params = {}) ⇒ Types::ListApplicationVersionsResponse

Lists versions for the specified application.

Examples:

Request syntax with placeholder values


resp = client.list_application_versions({
  application_id: "__string", # required
  max_items: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.versions #=> Array
resp.versions[0].application_id #=> String
resp.versions[0].creation_time #=> String
resp.versions[0].semantic_version #=> String
resp.versions[0].source_code_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :max_items (Integer)
  • :next_token (String)

Returns:

See Also:



536
537
538
539
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 536

def list_application_versions(params = {}, options = {})
  req = build_request(:list_application_versions, params)
  req.send_request(options)
end

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Lists applications owned by the requester.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  max_items: 1,
  next_token: "__string",
})

Response structure


resp.applications #=> Array
resp.applications[0].application_id #=> String
resp.applications[0].author #=> String
resp.applications[0].creation_time #=> String
resp.applications[0].description #=> String
resp.applications[0].home_page_url #=> String
resp.applications[0].labels #=> Array
resp.applications[0].labels[0] #=> String
resp.applications[0].name #=> String
resp.applications[0].spdx_license_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_items (Integer)
  • :next_token (String)

Returns:

See Also:



577
578
579
580
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 577

def list_applications(params = {}, options = {})
  req = build_request(:list_applications, params)
  req.send_request(options)
end

#put_application_policy(params = {}) ⇒ Types::PutApplicationPolicyResponse

Sets the permission policy for an application. See Application Permissions for the list of supported actions that can be used with this operation.

Examples:

Request syntax with placeholder values


resp = client.put_application_policy({
  application_id: "__string", # required
  statements: [ # required
    {
      actions: ["__string"], # required
      principals: ["__string"], # required
      statement_id: "__string",
    },
  ],
})

Response structure


resp.statements #=> Array
resp.statements[0].actions #=> Array
resp.statements[0].actions[0] #=> String
resp.statements[0].principals #=> Array
resp.statements[0].principals[0] #=> String
resp.statements[0].statement_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



624
625
626
627
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 624

def put_application_policy(params = {}, options = {})
  req = build_request(:put_application_policy, params)
  req.send_request(options)
end

#update_application(params = {}) ⇒ Types::UpdateApplicationResponse

Updates the specified application.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  application_id: "__string", # required
  author: "__string",
  description: "__string",
  home_page_url: "__string",
  labels: ["__string"],
  readme_body: "__string",
  readme_url: "__string",
})

Response structure


resp.application_id #=> String
resp.author #=> String
resp.creation_time #=> String
resp.description #=> String
resp.home_page_url #=> String
resp.labels #=> Array
resp.labels[0] #=> String
resp.license_url #=> String
resp.name #=> String
resp.readme_url #=> String
resp.spdx_license_id #=> String
resp.version.application_id #=> String
resp.version.creation_time #=> String
resp.version.parameter_definitions #=> Array
resp.version.parameter_definitions[0].allowed_pattern #=> String
resp.version.parameter_definitions[0].allowed_values #=> Array
resp.version.parameter_definitions[0].allowed_values[0] #=> String
resp.version.parameter_definitions[0].constraint_description #=> String
resp.version.parameter_definitions[0].default_value #=> String
resp.version.parameter_definitions[0].description #=> String
resp.version.parameter_definitions[0].max_length #=> Integer
resp.version.parameter_definitions[0].max_value #=> Integer
resp.version.parameter_definitions[0].min_length #=> Integer
resp.version.parameter_definitions[0].min_value #=> Integer
resp.version.parameter_definitions[0].name #=> String
resp.version.parameter_definitions[0].no_echo #=> Boolean
resp.version.parameter_definitions[0].referenced_by_resources #=> Array
resp.version.parameter_definitions[0].referenced_by_resources[0] #=> String
resp.version.parameter_definitions[0].type #=> String
resp.version.semantic_version #=> String
resp.version.source_code_url #=> String
resp.version.template_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :application_id (required, String)
  • :author (String)
  • :description (String)
  • :home_page_url (String)
  • :labels (Array<String>)
  • :readme_body (String)
  • :readme_url (String)

Returns:

See Also:



710
711
712
713
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/client.rb', line 710

def update_application(params = {}, options = {})
  req = build_request(:update_application, params)
  req.send_request(options)
end