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

Class: Aws::Amplify::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #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(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



251
252
253
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

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

Creates a new Amplify App.

Examples:

Request syntax with placeholder values


resp = client.create_app({
  name: "Name", # required
  description: "Description",
  repository: "Repository",
  platform: "WEB", # accepts WEB
  iam_service_role_arn: "ServiceRoleArn",
  oauth_token: "OauthToken",
  access_token: "AccessToken",
  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",
  enable_auto_branch_creation: false,
  auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
  auto_branch_creation_config: {
    stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
    framework: "Framework",
    enable_auto_build: false,
    environment_variables: {
      "EnvKey" => "EnvValue",
    },
    basic_auth_credentials: "BasicAuthCredentials",
    enable_basic_auth: false,
    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 "WEB"
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 #=> Boolean
resp.app.enable_basic_auth #=> Boolean
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
resp.app.enable_auto_branch_creation #=> Boolean
resp.app.auto_branch_creation_patterns #=> Array
resp.app.auto_branch_creation_patterns[0] #=> String
resp.app.auto_branch_creation_config.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.app.auto_branch_creation_config.framework #=> String
resp.app.auto_branch_creation_config.enable_auto_build #=> Boolean
resp.app.auto_branch_creation_config.environment_variables #=> Hash
resp.app.auto_branch_creation_config.environment_variables["EnvKey"] #=> String
resp.app.auto_branch_creation_config.basic_auth_credentials #=> String
resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
resp.app.auto_branch_creation_config.build_spec #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    Name for the Amplify App

  • :description (String) —

    Description for an Amplify App

  • :repository (String) —

    Repository for an Amplify App

  • :platform (String) —

    Platform / framework for an Amplify App

  • :iam_service_role_arn (String) —

    AWS IAM service role for an Amplify App

  • :oauth_token (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.

  • :access_token (String) —

    Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. 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

  • :enable_auto_branch_creation (Boolean) —

    Enables automated branch creation for the Amplify App.

  • :auto_branch_creation_patterns (Array<String>) —

    Automated branch creation glob patterns for the Amplify App.

  • :auto_branch_creation_config (Types::AutoBranchCreationConfig) —

    Automated branch creation config for the Amplify App.

Returns:

See Also:



407
408
409
410
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 407

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

#create_branch(params = {}) ⇒ 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",
  display_name: "DisplayName",
})

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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String
resp.branch.associated_resources #=> Array
resp.branch.associated_resources[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :display_name (String) —

    Display name for a branch, will use as the default domain prefix.

Returns:

See Also:



515
516
517
518
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 515

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

#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult

Create a deployment for manual deploy apps. (Apps are not connected to repository)

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  file_map: {
    "FileName" => "MD5Hash",
  },
})

Response structure


resp.job_id #=> String
resp.file_upload_urls #=> Hash
resp.file_upload_urls["FileName"] #=> String
resp.zip_upload_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :branch_name (required, String) —

    Name for the branch, for the Job.

  • :file_map (Hash<String,String>) —

    Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files.

Returns:

See Also:



562
563
564
565
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 562

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

#create_domain_association(params = {}) ⇒ 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 #=> Boolean
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
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 #=> Boolean
resp.domain_association.sub_domains[0].dns_record #=> String

Parameters:

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

    ({})

Options Hash (params):

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



617
618
619
620
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 617

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

#create_webhook(params = {}) ⇒ Types::CreateWebhookResult

Create a new webhook on an App.

Examples:

Request syntax with placeholder values


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

Response structure


resp.webhook.webhook_arn #=> String
resp.webhook.webhook_id #=> String
resp.webhook.webhook_url #=> String
resp.webhook.branch_name #=> String
resp.webhook.description #=> String
resp.webhook.create_time #=> Time
resp.webhook.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :branch_name (required, String) —

    Name for a branch, part of an Amplify App.

  • :description (String) —

    Description for a webhook.

Returns:

See Also:



659
660
661
662
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 659

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

#delete_app(params = {}) ⇒ 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 "WEB"
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 #=> Boolean
resp.app.enable_basic_auth #=> Boolean
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
resp.app.enable_auto_branch_creation #=> Boolean
resp.app.auto_branch_creation_patterns #=> Array
resp.app.auto_branch_creation_patterns[0] #=> String
resp.app.auto_branch_creation_config.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.app.auto_branch_creation_config.framework #=> String
resp.app.auto_branch_creation_config.enable_auto_build #=> Boolean
resp.app.auto_branch_creation_config.environment_variables #=> Hash
resp.app.auto_branch_creation_config.environment_variables["EnvKey"] #=> String
resp.app.auto_branch_creation_config.basic_auth_credentials #=> String
resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
resp.app.auto_branch_creation_config.build_spec #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

Returns:

See Also:



724
725
726
727
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 724

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

#delete_branch(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String
resp.branch.associated_resources #=> Array
resp.branch.associated_resources[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :branch_name (required, String) —

    Name for the branch.

Returns:

See Also:



780
781
782
783
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 780

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

#delete_domain_association(params = {}) ⇒ 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 #=> Boolean
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
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 #=> Boolean
resp.domain_association.sub_domains[0].dns_record #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :domain_name (required, String) —

    Name of the domain.

Returns:

See Also:



822
823
824
825
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 822

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

#delete_job(params = {}) ⇒ 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", "MANUAL", "WEB_HOOK"

Parameters:

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

    ({})

Options Hash (params):

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



866
867
868
869
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 866

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

#delete_webhook(params = {}) ⇒ Types::DeleteWebhookResult

Deletes a webhook.

Examples:

Request syntax with placeholder values


resp = client.delete_webhook({
  webhook_id: "WebhookId", # required
})

Response structure


resp.webhook.webhook_arn #=> String
resp.webhook.webhook_id #=> String
resp.webhook.webhook_url #=> String
resp.webhook.branch_name #=> String
resp.webhook.description #=> String
resp.webhook.create_time #=> Time
resp.webhook.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :webhook_id (required, String) —

    Unique Id for a webhook.

Returns:

See Also:



900
901
902
903
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 900

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

#get_app(params = {}) ⇒ 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 "WEB"
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 #=> Boolean
resp.app.enable_basic_auth #=> Boolean
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
resp.app.enable_auto_branch_creation #=> Boolean
resp.app.auto_branch_creation_patterns #=> Array
resp.app.auto_branch_creation_patterns[0] #=> String
resp.app.auto_branch_creation_config.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.app.auto_branch_creation_config.framework #=> String
resp.app.auto_branch_creation_config.enable_auto_build #=> Boolean
resp.app.auto_branch_creation_config.environment_variables #=> Hash
resp.app.auto_branch_creation_config.environment_variables["EnvKey"] #=> String
resp.app.auto_branch_creation_config.basic_auth_credentials #=> String
resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
resp.app.auto_branch_creation_config.build_spec #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

Returns:

See Also:



965
966
967
968
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 965

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

#get_branch(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String
resp.branch.associated_resources #=> Array
resp.branch.associated_resources[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :branch_name (required, String) —

    Name for the branch.

Returns:

See Also:



1021
1022
1023
1024
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1021

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

#get_domain_association(params = {}) ⇒ 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 #=> Boolean
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
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 #=> Boolean
resp.domain_association.sub_domains[0].dns_record #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :domain_name (required, String) —

    Name of the domain.

Returns:

See Also:



1063
1064
1065
1066
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1063

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

#get_job(params = {}) ⇒ 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", "MANUAL", "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
resp.job.steps[0].status_reason #=> String
resp.job.steps[0].context #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1118
1119
1120
1121
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1118

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

#get_webhook(params = {}) ⇒ Types::GetWebhookResult

Retrieves webhook info that corresponds to a webhookId.

Examples:

Request syntax with placeholder values


resp = client.get_webhook({
  webhook_id: "WebhookId", # required
})

Response structure


resp.webhook.webhook_arn #=> String
resp.webhook.webhook_id #=> String
resp.webhook.webhook_url #=> String
resp.webhook.branch_name #=> String
resp.webhook.description #=> String
resp.webhook.create_time #=> Time
resp.webhook.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :webhook_id (required, String) —

    Unique Id for a webhook.

Returns:

See Also:



1152
1153
1154
1155
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1152

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

#list_apps(params = {}) ⇒ 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 "WEB"
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 #=> Boolean
resp.apps[0].enable_basic_auth #=> Boolean
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.apps[0].enable_auto_branch_creation #=> Boolean
resp.apps[0].auto_branch_creation_patterns #=> Array
resp.apps[0].auto_branch_creation_patterns[0] #=> String
resp.apps[0].auto_branch_creation_config.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.apps[0].auto_branch_creation_config.framework #=> String
resp.apps[0].auto_branch_creation_config.enable_auto_build #=> Boolean
resp.apps[0].auto_branch_creation_config.environment_variables #=> Hash
resp.apps[0].auto_branch_creation_config.environment_variables["EnvKey"] #=> String
resp.apps[0].auto_branch_creation_config.basic_auth_credentials #=> String
resp.apps[0].auto_branch_creation_config.enable_basic_auth #=> Boolean
resp.apps[0].auto_branch_creation_config.build_spec #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1225
1226
1227
1228
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1225

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

#list_branches(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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.branches[0].associated_resources #=> Array
resp.branches[0].associated_resources[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1290
1291
1292
1293
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1290

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

#list_domain_associations(params = {}) ⇒ 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 #=> Boolean
resp.domain_associations[0].domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
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 #=> Boolean
resp.domain_associations[0].sub_domains[0].dns_record #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1341
1342
1343
1344
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1341

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

#list_jobs(params = {}) ⇒ 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", "MANUAL", "WEB_HOOK"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1394
1395
1396
1397
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1394

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List tags for resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Resource arn used to list tags.

Returns:

See Also:



1423
1424
1425
1426
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1423

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

#list_webhooks(params = {}) ⇒ Types::ListWebhooksResult

List webhooks with an app.

Examples:

Request syntax with placeholder values


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

Response structure


resp.webhooks #=> Array
resp.webhooks[0].webhook_arn #=> String
resp.webhooks[0].webhook_id #=> String
resp.webhooks[0].webhook_url #=> String
resp.webhooks[0].branch_name #=> String
resp.webhooks[0].description #=> String
resp.webhooks[0].create_time #=> Time
resp.webhooks[0].update_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :next_token (String) —

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

  • :max_results (Integer) —

    Maximum number of records to list in a single response.

Returns:

See Also:



1470
1471
1472
1473
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1470

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

#start_deployment(params = {}) ⇒ Types::StartDeploymentResult

Start a deployment for manual deploy apps. (Apps are not connected to repository)

Examples:

Request syntax with placeholder values


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

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", "MANUAL", "WEB_HOOK"

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String) —

    Unique Id for an Amplify App.

  • :branch_name (required, String) —

    Name for the branch, for the Job.

  • :job_id (String) —

    The job id for this deployment, generated by create deployment request.

  • :source_url (String) —

    The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.

Returns:

See Also:



1522
1523
1524
1525
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1522

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

#start_job(params = {}) ⇒ 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, MANUAL, 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", "MANUAL", "WEB_HOOK"

Parameters:

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

    ({})

Options Hash (params):

  • :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 an existing job. Required for "RETRY" JobType.

  • :job_type (required, String) —

    Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

  • :job_reason (String) —

    Descriptive reason for starting this 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, DateTime, Date, Integer, String) —

    Commit date / time for the Job.

Returns:

See Also:



1589
1590
1591
1592
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1589

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

#stop_job(params = {}) ⇒ 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", "MANUAL", "WEB_HOOK"

Parameters:

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

    ({})

Options Hash (params):

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



1634
1635
1636
1637
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1634

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

#tag_resource(params = {}) ⇒ Struct

Tag resource with tag key and value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Resource arn used to tag resource.

  • :tags (required, Hash<String,String>) —

    Tags used to tag resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1662
1663
1664
1665
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1662

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

#untag_resource(params = {}) ⇒ Struct

Untag resource with resourceArn.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Resource arn used to untag resource.

  • :tag_keys (required, Array<String>) —

    Tag keys used to untag resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1688
1689
1690
1691
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1688

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

#update_app(params = {}) ⇒ 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: "WEB", # accepts WEB
  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",
  enable_auto_branch_creation: false,
  auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
  auto_branch_creation_config: {
    stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
    framework: "Framework",
    enable_auto_build: false,
    environment_variables: {
      "EnvKey" => "EnvValue",
    },
    basic_auth_credentials: "BasicAuthCredentials",
    enable_basic_auth: false,
    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 "WEB"
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 #=> Boolean
resp.app.enable_basic_auth #=> Boolean
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
resp.app.enable_auto_branch_creation #=> Boolean
resp.app.auto_branch_creation_patterns #=> Array
resp.app.auto_branch_creation_patterns[0] #=> String
resp.app.auto_branch_creation_config.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
resp.app.auto_branch_creation_config.framework #=> String
resp.app.auto_branch_creation_config.enable_auto_build #=> Boolean
resp.app.auto_branch_creation_config.environment_variables #=> Hash
resp.app.auto_branch_creation_config.environment_variables["EnvKey"] #=> String
resp.app.auto_branch_creation_config.basic_auth_credentials #=> String
resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
resp.app.auto_branch_creation_config.build_spec #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :enable_auto_branch_creation (Boolean) —

    Enables automated branch creation for the Amplify App.

  • :auto_branch_creation_patterns (Array<String>) —

    Automated branch creation glob patterns for the Amplify App.

  • :auto_branch_creation_config (Types::AutoBranchCreationConfig) —

    Automated branch creation config for the Amplify App.

Returns:

See Also:



1824
1825
1826
1827
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1824

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

#update_branch(params = {}) ⇒ 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",
  display_name: "DisplayName",
})

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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.branch.thumbnail_url #=> String
resp.branch.basic_auth_credentials #=> String
resp.branch.build_spec #=> String
resp.branch.ttl #=> String
resp.branch.associated_resources #=> Array
resp.branch.associated_resources[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :display_name (String) —

    Display name for a branch, will use as the default domain prefix.

Returns:

See Also:



1926
1927
1928
1929
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1926

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

#update_domain_association(params = {}) ⇒ 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 #=> Boolean
resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
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 #=> Boolean
resp.domain_association.sub_domains[0].dns_record #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1981
1982
1983
1984
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1981

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

#update_webhook(params = {}) ⇒ Types::UpdateWebhookResult

Update a webhook.

Examples:

Request syntax with placeholder values


resp = client.update_webhook({
  webhook_id: "WebhookId", # required
  branch_name: "BranchName",
  description: "Description",
})

Response structure


resp.webhook.webhook_arn #=> String
resp.webhook.webhook_id #=> String
resp.webhook.webhook_url #=> String
resp.webhook.branch_name #=> String
resp.webhook.description #=> String
resp.webhook.create_time #=> Time
resp.webhook.update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :webhook_id (required, String) —

    Unique Id for a webhook.

  • :branch_name (String) —

    Name for a branch, part of an Amplify App.

  • :description (String) —

    Description for a webhook.

Returns:

See Also:



2023
2024
2025
2026
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2023

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