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

Class: Aws::Amplify::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Amplify. To construct a client, you need to configure a :region and :credentials.

amplify = Aws::Amplify::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Amplify::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::Amplify::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_app(options = {}) ⇒ Types::CreateAppResult

Creates a new Amplify App.

Examples:

Request syntax with placeholder values


resp = client.create_app({
  name: "Name", # required
  description: "Description",
  repository: "Repository", # required
  platform: "IOS", # required, accepts IOS, ANDROID, WEB, REACT_NATIVE
  iam_service_role_arn: "ServiceRoleArn",
  oauth_token: "OauthToken", # required
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  enable_branch_auto_build: false,
  enable_basic_auth: false,
  basic_auth_credentials: "BasicAuthCredentials",
  custom_rules: [
    {
      source: "Source", # required
      target: "Target", # required
      status: "Status",
      condition: "Condition",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  build_spec: "BuildSpec",
})

Response structure


resp.app.app_id #=> String
resp.app.app_arn #=> String
resp.app.name #=> String
resp.app.tags #=> Hash
resp.app.tags["TagKey"] #=> String
resp.app.description #=> String
resp.app.repository #=> String
resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
resp.app.create_time #=> Time
resp.app.update_time #=> Time
resp.app.iam_service_role_arn #=> String
resp.app.environment_variables #=> Hash
resp.app.environment_variables["EnvKey"] #=> String
resp.app.default_domain #=> String
resp.app.enable_branch_auto_build #=> true/false
resp.app.enable_basic_auth #=> true/false
resp.app.basic_auth_credentials #=> String
resp.app.custom_rules #=> Array
resp.app.custom_rules[0].source #=> String
resp.app.custom_rules[0].target #=> String
resp.app.custom_rules[0].status #=> String
resp.app.custom_rules[0].condition #=> String
resp.app.production_branch.last_deploy_time #=> Time
resp.app.production_branch.status #=> String
resp.app.production_branch.thumbnail_url #=> String
resp.app.production_branch.branch_name #=> String
resp.app.build_spec #=> String

Options Hash (options):

  • :name (required, String)

    Name for the Amplify App

  • :description (String)

    Description for an Amplify App

  • :repository (required, String)

    Repository for an Amplify App

  • :platform (required, String)

    Platform / framework for an Amplify App

  • :iam_service_role_arn (String)

    AWS IAM service role for an Amplify App

  • :oauth_token (required, String)

    OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

  • :environment_variables (Hash<String,String>)

    Environment variables map for an Amplify App.

  • :enable_branch_auto_build (Boolean)

    Enable the auto building of branches for an Amplify App.

  • :enable_basic_auth (Boolean)

    Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

  • :basic_auth_credentials (String)

    Credentials for Basic Authorization for an Amplify App.

  • :custom_rules (Array<Types::CustomRule>)

    Custom rewrite / redirect rules for an Amplify App.

  • :tags (Hash<String,String>)

    Tag for an Amplify App

  • :build_spec (String)

    BuildSpec for an Amplify App

Returns:

See Also:

#create_branch(options = {}) ⇒ Types::CreateBranchResult

Creates a new Branch for an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.create_branch({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  description: "Description",
  stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
  framework: "Framework",
  enable_notification: false,
  enable_auto_build: false,
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  basic_auth_credentials: "BasicAuthCredentials",
  enable_basic_auth: false,
  tags: {
    "TagKey" => "TagValue",
  },
  build_spec: "BuildSpec",
  ttl: "TTL",
})

Response structure


resp.branch.branch_arn #=> String
resp.branch.branch_name #=> String
resp.branch.description #=> String
resp.branch.tags #=> Hash
resp.branch.tags["TagKey"] #=> String
resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.branch.display_name #=> String
resp.branch.enable_notification #=> true/false
resp.branch.create_time #=> Time
resp.branch.update_time #=> Time
resp.branch.environment_variables #=> Hash
resp.branch.environment_variables["EnvKey"] #=> String
resp.branch.enable_auto_build #=> true/false
resp.branch.custom_domains #=> Array
resp.branch.custom_domains[0] #=> String
resp.branch.framework #=> String
resp.branch.active_job_id #=> String
resp.branch.total_number_of_jobs #=> String
resp.branch.enable_basic_auth #=> true/false
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch.

  • :description (String)

    Description for the branch.

  • :stage (String)

    Stage for the branch.

  • :framework (String)

    Framework for the branch.

  • :enable_notification (Boolean)

    Enables notifications for the branch.

  • :enable_auto_build (Boolean)

    Enables auto building for the branch.

  • :environment_variables (Hash<String,String>)

    Environment Variables for the branch.

  • :basic_auth_credentials (String)

    Basic Authorization credentials for the branch.

  • :enable_basic_auth (Boolean)

    Enables Basic Auth for the branch.

  • :tags (Hash<String,String>)

    Tag for the branch.

  • :build_spec (String)

    BuildSpec for the branch.

  • :ttl (String)

    The content TTL for the website in seconds.

Returns:

See Also:

#create_domain_association(options = {}) ⇒ Types::CreateDomainAssociationResult

Create a new DomainAssociation on an App

Examples:

Request syntax with placeholder values


resp = client.create_domain_association({
  app_id: "AppId", # required
  domain_name: "DomainName", # required
  enable_auto_sub_domain: false,
  sub_domain_settings: [ # required
    {
      prefix: "DomainPrefix", # required
      branch_name: "BranchName", # required
    },
  ],
})

Response structure


resp.domain_association.domain_association_arn #=> String
resp.domain_association.domain_name #=> String
resp.domain_association.enable_auto_sub_domain #=> true/false
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
resp.domain_association.status_reason #=> String
resp.domain_association.certificate_verification_dns_record #=> String
resp.domain_association.sub_domains #=> Array
resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
resp.domain_association.sub_domains[0].verified #=> true/false
resp.domain_association.sub_domains[0].dns_record #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :domain_name (required, String)

    Domain name for the Domain Association.

  • :enable_auto_sub_domain (Boolean)

    Enables automated creation of Subdomains for branches.

  • :sub_domain_settings (required, Array<Types::SubDomainSetting>)

    Setting structure for the Subdomain.

Returns:

See Also:

#delete_app(options = {}) ⇒ Types::DeleteAppResult

Delete an existing Amplify App by appId.

Examples:

Request syntax with placeholder values


resp = client.delete_app({
  app_id: "AppId", # required
})

Response structure


resp.app.app_id #=> String
resp.app.app_arn #=> String
resp.app.name #=> String
resp.app.tags #=> Hash
resp.app.tags["TagKey"] #=> String
resp.app.description #=> String
resp.app.repository #=> String
resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
resp.app.create_time #=> Time
resp.app.update_time #=> Time
resp.app.iam_service_role_arn #=> String
resp.app.environment_variables #=> Hash
resp.app.environment_variables["EnvKey"] #=> String
resp.app.default_domain #=> String
resp.app.enable_branch_auto_build #=> true/false
resp.app.enable_basic_auth #=> true/false
resp.app.basic_auth_credentials #=> String
resp.app.custom_rules #=> Array
resp.app.custom_rules[0].source #=> String
resp.app.custom_rules[0].target #=> String
resp.app.custom_rules[0].status #=> String
resp.app.custom_rules[0].condition #=> String
resp.app.production_branch.last_deploy_time #=> Time
resp.app.production_branch.status #=> String
resp.app.production_branch.thumbnail_url #=> String
resp.app.production_branch.branch_name #=> String
resp.app.build_spec #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

Returns:

See Also:

#delete_branch(options = {}) ⇒ Types::DeleteBranchResult

Deletes a branch for an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.delete_branch({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
})

Response structure


resp.branch.branch_arn #=> String
resp.branch.branch_name #=> String
resp.branch.description #=> String
resp.branch.tags #=> Hash
resp.branch.tags["TagKey"] #=> String
resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.branch.display_name #=> String
resp.branch.enable_notification #=> true/false
resp.branch.create_time #=> Time
resp.branch.update_time #=> Time
resp.branch.environment_variables #=> Hash
resp.branch.environment_variables["EnvKey"] #=> String
resp.branch.enable_auto_build #=> true/false
resp.branch.custom_domains #=> Array
resp.branch.custom_domains[0] #=> String
resp.branch.framework #=> String
resp.branch.active_job_id #=> String
resp.branch.total_number_of_jobs #=> String
resp.branch.enable_basic_auth #=> true/false
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch.

Returns:

See Also:

#delete_domain_association(options = {}) ⇒ Types::DeleteDomainAssociationResult

Deletes a DomainAssociation.

Examples:

Request syntax with placeholder values


resp = client.delete_domain_association({
  app_id: "AppId", # required
  domain_name: "DomainName", # required
})

Response structure


resp.domain_association.domain_association_arn #=> String
resp.domain_association.domain_name #=> String
resp.domain_association.enable_auto_sub_domain #=> true/false
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
resp.domain_association.status_reason #=> String
resp.domain_association.certificate_verification_dns_record #=> String
resp.domain_association.sub_domains #=> Array
resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
resp.domain_association.sub_domains[0].verified #=> true/false
resp.domain_association.sub_domains[0].dns_record #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :domain_name (required, String)

    Name of the domain.

Returns:

See Also:

#delete_job(options = {}) ⇒ Types::DeleteJobResult

Delete a job, for an Amplify branch, part of Amplify App.

Examples:

Request syntax with placeholder values


resp = client.delete_job({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  job_id: "JobId", # required
})

Response structure


resp.job_summary.job_arn #=> String
resp.job_summary.job_id #=> String
resp.job_summary.commit_id #=> String
resp.job_summary.commit_message #=> String
resp.job_summary.commit_time #=> Time
resp.job_summary.start_time #=> Time
resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
resp.job_summary.end_time #=> Time
resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch, for the Job.

  • :job_id (required, String)

    Unique Id for the Job.

Returns:

See Also:

#get_app(options = {}) ⇒ Types::GetAppResult

Retrieves an existing Amplify App by appId.

Examples:

Request syntax with placeholder values


resp = client.get_app({
  app_id: "AppId", # required
})

Response structure


resp.app.app_id #=> String
resp.app.app_arn #=> String
resp.app.name #=> String
resp.app.tags #=> Hash
resp.app.tags["TagKey"] #=> String
resp.app.description #=> String
resp.app.repository #=> String
resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
resp.app.create_time #=> Time
resp.app.update_time #=> Time
resp.app.iam_service_role_arn #=> String
resp.app.environment_variables #=> Hash
resp.app.environment_variables["EnvKey"] #=> String
resp.app.default_domain #=> String
resp.app.enable_branch_auto_build #=> true/false
resp.app.enable_basic_auth #=> true/false
resp.app.basic_auth_credentials #=> String
resp.app.custom_rules #=> Array
resp.app.custom_rules[0].source #=> String
resp.app.custom_rules[0].target #=> String
resp.app.custom_rules[0].status #=> String
resp.app.custom_rules[0].condition #=> String
resp.app.production_branch.last_deploy_time #=> Time
resp.app.production_branch.status #=> String
resp.app.production_branch.thumbnail_url #=> String
resp.app.production_branch.branch_name #=> String
resp.app.build_spec #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

Returns:

See Also:

#get_branch(options = {}) ⇒ Types::GetBranchResult

Retrieves a branch for an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.get_branch({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
})

Response structure


resp.branch.branch_arn #=> String
resp.branch.branch_name #=> String
resp.branch.description #=> String
resp.branch.tags #=> Hash
resp.branch.tags["TagKey"] #=> String
resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.branch.display_name #=> String
resp.branch.enable_notification #=> true/false
resp.branch.create_time #=> Time
resp.branch.update_time #=> Time
resp.branch.environment_variables #=> Hash
resp.branch.environment_variables["EnvKey"] #=> String
resp.branch.enable_auto_build #=> true/false
resp.branch.custom_domains #=> Array
resp.branch.custom_domains[0] #=> String
resp.branch.framework #=> String
resp.branch.active_job_id #=> String
resp.branch.total_number_of_jobs #=> String
resp.branch.enable_basic_auth #=> true/false
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch.

Returns:

See Also:

#get_domain_association(options = {}) ⇒ Types::GetDomainAssociationResult

Retrieves domain info that corresponds to an appId and domainName.

Examples:

Request syntax with placeholder values


resp = client.get_domain_association({
  app_id: "AppId", # required
  domain_name: "DomainName", # required
})

Response structure


resp.domain_association.domain_association_arn #=> String
resp.domain_association.domain_name #=> String
resp.domain_association.enable_auto_sub_domain #=> true/false
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
resp.domain_association.status_reason #=> String
resp.domain_association.certificate_verification_dns_record #=> String
resp.domain_association.sub_domains #=> Array
resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
resp.domain_association.sub_domains[0].verified #=> true/false
resp.domain_association.sub_domains[0].dns_record #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :domain_name (required, String)

    Name of the domain.

Returns:

See Also:

#get_job(options = {}) ⇒ Types::GetJobResult

Get a job for a branch, part of an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.get_job({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  job_id: "JobId", # required
})

Response structure


resp.job.summary.job_arn #=> String
resp.job.summary.job_id #=> String
resp.job.summary.commit_id #=> String
resp.job.summary.commit_message #=> String
resp.job.summary.commit_time #=> Time
resp.job.summary.start_time #=> Time
resp.job.summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
resp.job.summary.end_time #=> Time
resp.job.summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
resp.job.steps #=> Array
resp.job.steps[0].step_name #=> String
resp.job.steps[0].start_time #=> Time
resp.job.steps[0].status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
resp.job.steps[0].end_time #=> Time
resp.job.steps[0].log_url #=> String
resp.job.steps[0].artifacts_url #=> String
resp.job.steps[0].screenshots #=> Hash
resp.job.steps[0].screenshots["ThumbnailName"] #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch, for the Job.

  • :job_id (required, String)

    Unique Id for the Job.

Returns:

See Also:

#list_apps(options = {}) ⇒ Types::ListAppsResult

Lists existing Amplify Apps.

Examples:

Request syntax with placeholder values


resp = client.list_apps({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.apps #=> Array
resp.apps[0].app_id #=> String
resp.apps[0].app_arn #=> String
resp.apps[0].name #=> String
resp.apps[0].tags #=> Hash
resp.apps[0].tags["TagKey"] #=> String
resp.apps[0].description #=> String
resp.apps[0].repository #=> String
resp.apps[0].platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
resp.apps[0].create_time #=> Time
resp.apps[0].update_time #=> Time
resp.apps[0].iam_service_role_arn #=> String
resp.apps[0].environment_variables #=> Hash
resp.apps[0].environment_variables["EnvKey"] #=> String
resp.apps[0].default_domain #=> String
resp.apps[0].enable_branch_auto_build #=> true/false
resp.apps[0].enable_basic_auth #=> true/false
resp.apps[0].basic_auth_credentials #=> String
resp.apps[0].custom_rules #=> Array
resp.apps[0].custom_rules[0].source #=> String
resp.apps[0].custom_rules[0].target #=> String
resp.apps[0].custom_rules[0].status #=> String
resp.apps[0].custom_rules[0].condition #=> String
resp.apps[0].production_branch.last_deploy_time #=> Time
resp.apps[0].production_branch.status #=> String
resp.apps[0].production_branch.thumbnail_url #=> String
resp.apps[0].production_branch.branch_name #=> String
resp.apps[0].build_spec #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String)

    Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

  • :max_results (Integer)

    Maximum number of records to list in a single response.

Returns:

See Also:

#list_branches(options = {}) ⇒ Types::ListBranchesResult

Lists branches for an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.list_branches({
  app_id: "AppId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.branches #=> Array
resp.branches[0].branch_arn #=> String
resp.branches[0].branch_name #=> String
resp.branches[0].description #=> String
resp.branches[0].tags #=> Hash
resp.branches[0].tags["TagKey"] #=> String
resp.branches[0].stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.branches[0].display_name #=> String
resp.branches[0].enable_notification #=> true/false
resp.branches[0].create_time #=> Time
resp.branches[0].update_time #=> Time
resp.branches[0].environment_variables #=> Hash
resp.branches[0].environment_variables["EnvKey"] #=> String
resp.branches[0].enable_auto_build #=> true/false
resp.branches[0].custom_domains #=> Array
resp.branches[0].custom_domains[0] #=> String
resp.branches[0].framework #=> String
resp.branches[0].active_job_id #=> String
resp.branches[0].total_number_of_jobs #=> String
resp.branches[0].enable_basic_auth #=> true/false
resp.branches[0].thumbnail_url #=> String
resp.branches[0].basic_auth_credentials #=> String
resp.branches[0].build_spec #=> String
resp.branches[0].ttl #=> String
resp.next_token #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :next_token (String)

    Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.

  • :max_results (Integer)

    Maximum number of records to list in a single response.

Returns:

See Also:

#list_domain_associations(options = {}) ⇒ Types::ListDomainAssociationsResult

List domains with an app

Examples:

Request syntax with placeholder values


resp = client.list_domain_associations({
  app_id: "AppId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.domain_associations #=> Array
resp.domain_associations[0].domain_association_arn #=> String
resp.domain_associations[0].domain_name #=> String
resp.domain_associations[0].enable_auto_sub_domain #=> true/false
resp.domain_associations[0].domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
resp.domain_associations[0].status_reason #=> String
resp.domain_associations[0].certificate_verification_dns_record #=> String
resp.domain_associations[0].sub_domains #=> Array
resp.domain_associations[0].sub_domains[0].sub_domain_setting.prefix #=> String
resp.domain_associations[0].sub_domains[0].sub_domain_setting.branch_name #=> String
resp.domain_associations[0].sub_domains[0].verified #=> true/false
resp.domain_associations[0].sub_domains[0].dns_record #=> String
resp.next_token #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :next_token (String)

    Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

  • :max_results (Integer)

    Maximum number of records to list in a single response.

Returns:

See Also:

#list_jobs(options = {}) ⇒ Types::ListJobsResult

List Jobs for a branch, part of an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.list_jobs({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.job_summaries #=> Array
resp.job_summaries[0].job_arn #=> String
resp.job_summaries[0].job_id #=> String
resp.job_summaries[0].commit_id #=> String
resp.job_summaries[0].commit_message #=> String
resp.job_summaries[0].commit_time #=> Time
resp.job_summaries[0].start_time #=> Time
resp.job_summaries[0].status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
resp.job_summaries[0].end_time #=> Time
resp.job_summaries[0].job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
resp.next_token #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for a branch.

  • :next_token (String)

    Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.

  • :max_results (Integer)

    Maximum number of records to list in a single response.

Returns:

See Also:

#start_job(options = {}) ⇒ Types::StartJobResult

Starts a new job for a branch, part of an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.start_job({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  job_id: "JobId",
  job_type: "RELEASE", # required, accepts RELEASE, RETRY, WEB_HOOK
  job_reason: "JobReason",
  commit_id: "CommitId",
  commit_message: "CommitMessage",
  commit_time: Time.now,
})

Response structure


resp.job_summary.job_arn #=> String
resp.job_summary.job_id #=> String
resp.job_summary.commit_id #=> String
resp.job_summary.commit_message #=> String
resp.job_summary.commit_time #=> Time
resp.job_summary.start_time #=> Time
resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
resp.job_summary.end_time #=> Time
resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch, for the Job.

  • :job_id (String)

    Unique Id for the Job.

  • :job_type (required, String)

    Type for the Job.

  • :job_reason (String)

    Reason for the Job.

  • :commit_id (String)

    Commit Id from 3rd party repository provider for the Job.

  • :commit_message (String)

    Commit message from 3rd party repository provider for the Job.

  • :commit_time (Time)

    Commit date / time for the Job.

Returns:

See Also:

#stop_job(options = {}) ⇒ Types::StopJobResult

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

Examples:

Request syntax with placeholder values


resp = client.stop_job({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  job_id: "JobId", # required
})

Response structure


resp.job_summary.job_arn #=> String
resp.job_summary.job_id #=> String
resp.job_summary.commit_id #=> String
resp.job_summary.commit_message #=> String
resp.job_summary.commit_time #=> Time
resp.job_summary.start_time #=> Time
resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
resp.job_summary.end_time #=> Time
resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch, for the Job.

  • :job_id (required, String)

    Unique Id for the Job.

Returns:

See Also:

#update_app(options = {}) ⇒ Types::UpdateAppResult

Updates an existing Amplify App.

Examples:

Request syntax with placeholder values


resp = client.update_app({
  app_id: "AppId", # required
  name: "Name",
  description: "Description",
  platform: "IOS", # accepts IOS, ANDROID, WEB, REACT_NATIVE
  iam_service_role_arn: "ServiceRoleArn",
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  enable_branch_auto_build: false,
  enable_basic_auth: false,
  basic_auth_credentials: "BasicAuthCredentials",
  custom_rules: [
    {
      source: "Source", # required
      target: "Target", # required
      status: "Status",
      condition: "Condition",
    },
  ],
  build_spec: "BuildSpec",
})

Response structure


resp.app.app_id #=> String
resp.app.app_arn #=> String
resp.app.name #=> String
resp.app.tags #=> Hash
resp.app.tags["TagKey"] #=> String
resp.app.description #=> String
resp.app.repository #=> String
resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
resp.app.create_time #=> Time
resp.app.update_time #=> Time
resp.app.iam_service_role_arn #=> String
resp.app.environment_variables #=> Hash
resp.app.environment_variables["EnvKey"] #=> String
resp.app.default_domain #=> String
resp.app.enable_branch_auto_build #=> true/false
resp.app.enable_basic_auth #=> true/false
resp.app.basic_auth_credentials #=> String
resp.app.custom_rules #=> Array
resp.app.custom_rules[0].source #=> String
resp.app.custom_rules[0].target #=> String
resp.app.custom_rules[0].status #=> String
resp.app.custom_rules[0].condition #=> String
resp.app.production_branch.last_deploy_time #=> Time
resp.app.production_branch.status #=> String
resp.app.production_branch.thumbnail_url #=> String
resp.app.production_branch.branch_name #=> String
resp.app.build_spec #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :name (String)

    Name for an Amplify App.

  • :description (String)

    Description for an Amplify App.

  • :platform (String)

    Platform for an Amplify App.

  • :iam_service_role_arn (String)

    IAM service role for an Amplify App.

  • :environment_variables (Hash<String,String>)

    Environment Variables for an Amplify App.

  • :enable_branch_auto_build (Boolean)

    Enables branch auto-building for an Amplify App.

  • :enable_basic_auth (Boolean)

    Enables Basic Authorization for an Amplify App.

  • :basic_auth_credentials (String)

    Basic Authorization credentials for an Amplify App.

  • :custom_rules (Array<Types::CustomRule>)

    Custom redirect / rewrite rules for an Amplify App.

  • :build_spec (String)

    BuildSpec for an Amplify App.

Returns:

See Also:

#update_branch(options = {}) ⇒ Types::UpdateBranchResult

Updates a branch for an Amplify App.

Examples:

Request syntax with placeholder values


resp = client.update_branch({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  description: "Description",
  framework: "Framework",
  stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
  enable_notification: false,
  enable_auto_build: false,
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  basic_auth_credentials: "BasicAuthCredentials",
  enable_basic_auth: false,
  build_spec: "BuildSpec",
  ttl: "TTL",
})

Response structure


resp.branch.branch_arn #=> String
resp.branch.branch_name #=> String
resp.branch.description #=> String
resp.branch.tags #=> Hash
resp.branch.tags["TagKey"] #=> String
resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.branch.display_name #=> String
resp.branch.enable_notification #=> true/false
resp.branch.create_time #=> Time
resp.branch.update_time #=> Time
resp.branch.environment_variables #=> Hash
resp.branch.environment_variables["EnvKey"] #=> String
resp.branch.enable_auto_build #=> true/false
resp.branch.custom_domains #=> Array
resp.branch.custom_domains[0] #=> String
resp.branch.framework #=> String
resp.branch.active_job_id #=> String
resp.branch.total_number_of_jobs #=> String
resp.branch.enable_basic_auth #=> true/false
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :branch_name (required, String)

    Name for the branch.

  • :description (String)

    Description for the branch.

  • :framework (String)

    Framework for the branch.

  • :stage (String)

    Stage for the branch.

  • :enable_notification (Boolean)

    Enables notifications for the branch.

  • :enable_auto_build (Boolean)

    Enables auto building for the branch.

  • :environment_variables (Hash<String,String>)

    Environment Variables for the branch.

  • :basic_auth_credentials (String)

    Basic Authorization credentials for the branch.

  • :enable_basic_auth (Boolean)

    Enables Basic Auth for the branch.

  • :build_spec (String)

    BuildSpec for the branch.

  • :ttl (String)

    The content TTL for the website in seconds.

Returns:

See Also:

#update_domain_association(options = {}) ⇒ Types::UpdateDomainAssociationResult

Create a new DomainAssociation on an App

Examples:

Request syntax with placeholder values


resp = client.update_domain_association({
  app_id: "AppId", # required
  domain_name: "DomainName", # required
  enable_auto_sub_domain: false,
  sub_domain_settings: [ # required
    {
      prefix: "DomainPrefix", # required
      branch_name: "BranchName", # required
    },
  ],
})

Response structure


resp.domain_association.domain_association_arn #=> String
resp.domain_association.domain_name #=> String
resp.domain_association.enable_auto_sub_domain #=> true/false
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
resp.domain_association.status_reason #=> String
resp.domain_association.certificate_verification_dns_record #=> String
resp.domain_association.sub_domains #=> Array
resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
resp.domain_association.sub_domains[0].verified #=> true/false
resp.domain_association.sub_domains[0].dns_record #=> String

Options Hash (options):

  • :app_id (required, String)

    Unique Id for an Amplify App.

  • :domain_name (required, String)

    Name of the domain.

  • :enable_auto_sub_domain (Boolean)

    Enables automated creation of Subdomains for branches.

  • :sub_domain_settings (required, Array<Types::SubDomainSetting>)

    Setting structure for the Subdomain.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.