Class: Aws::AmplifyBackend::Client

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

Overview

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

client = Aws::AmplifyBackend::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

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

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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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 searched 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)
  • :account_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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::AmplifyBackend::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::AmplifyBackend::EndpointParameters.

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



478
479
480
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#clone_backend(params = {}) ⇒ Types::CloneBackendResponse

This operation clones an existing backend.

Examples:

Request syntax with placeholder values


resp = client.clone_backend({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  target_environment_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :target_environment_name (required, String)

Returns:

See Also:



522
523
524
525
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 522

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

#create_backend(params = {}) ⇒ Types::CreateBackendResponse

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Examples:

Request syntax with placeholder values


resp = client.create_backend({
  app_id: "__string", # required
  app_name: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: {
  },
  resource_name: "__string",
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :app_name (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (Types::ResourceConfig)
  • :resource_name (String)

Returns:

See Also:



573
574
575
576
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 573

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

#create_backend_api(params = {}) ⇒ Types::CreateBackendAPIResponse

Creates a new backend API resource.

Examples:

Request syntax with placeholder values


resp = client.create_backend_api({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: { # required
    additional_auth_types: [
      {
        mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
        settings: {
          cognito_user_pool_id: "__string",
          description: "__string",
          expiration_time: 1.0,
          open_id_auth_ttl: "__string",
          open_id_client_id: "__string",
          open_id_iat_ttl: "__string",
          open_id_issue_url: "__string",
          open_id_provider_name: "__string",
        },
      },
    ],
    api_name: "__string",
    conflict_resolution: {
      resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
    },
    default_auth_type: {
      mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      settings: {
        cognito_user_pool_id: "__string",
        description: "__string",
        expiration_time: 1.0,
        open_id_auth_ttl: "__string",
        open_id_client_id: "__string",
        open_id_iat_ttl: "__string",
        open_id_issue_url: "__string",
        open_id_provider_name: "__string",
      },
    },
    service: "__string",
    transform_schema: "__string",
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (required, Types::BackendAPIResourceConfig) —

    The resource config for the data model, configured as a part of the Amplify project.

  • :resource_name (required, String)

Returns:

See Also:



656
657
658
659
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 656

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

#create_backend_auth(params = {}) ⇒ Types::CreateBackendAuthResponse

Creates a new backend authentication resource.

Examples:

Request syntax with placeholder values


resp = client.create_backend_auth({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: { # required
    auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
    identity_pool_configs: {
      identity_pool_name: "__string", # required
      unauthenticated_login: false, # required
    },
    service: "COGNITO", # required, accepts COGNITO
    user_pool_configs: { # required
      forgot_password: {
        delivery_method: "EMAIL", # required, accepts EMAIL, SMS
        email_settings: {
          email_message: "__string",
          email_subject: "__string",
        },
        sms_settings: {
          sms_message: "__string",
        },
      },
      mfa: {
        mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
        settings: {
          mfa_types: ["SMS"], # accepts SMS, TOTP
          sms_message: "__string",
        },
      },
      o_auth: {
        domain_prefix: "__string",
        o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
        o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
        redirect_sign_in_ur_is: ["__string"], # required
        redirect_sign_out_ur_is: ["__string"], # required
        social_provider_settings: {
          facebook: {
            client_id: "__string",
            client_secret: "__string",
          },
          google: {
            client_id: "__string",
            client_secret: "__string",
          },
          login_with_amazon: {
            client_id: "__string",
            client_secret: "__string",
          },
          sign_in_with_apple: {
            client_id: "__string",
            key_id: "__string",
            private_key: "__string",
            team_id: "__string",
          },
        },
      },
      password_policy: {
        additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
        minimum_length: 1.0, # required
      },
      required_sign_up_attributes: ["ADDRESS"], # required, accepts ADDRESS, BIRTHDATE, EMAIL, FAMILY_NAME, GENDER, GIVEN_NAME, LOCALE, MIDDLE_NAME, NAME, NICKNAME, PHONE_NUMBER, PICTURE, PREFERRED_USERNAME, PROFILE, UPDATED_AT, WEBSITE, ZONE_INFO
      sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
      user_pool_name: "__string", # required
      verification_message: {
        delivery_method: "EMAIL", # required, accepts EMAIL, SMS
        email_settings: {
          email_message: "__string",
          email_subject: "__string",
        },
        sms_settings: {
          sms_message: "__string",
        },
      },
    },
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (required, Types::CreateBackendAuthResourceConfig) —

    Defines the resource configuration when creating an auth resource in your Amplify project.

  • :resource_name (required, String)

Returns:

See Also:



774
775
776
777
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 774

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

#create_backend_config(params = {}) ⇒ Types::CreateBackendConfigResponse

Creates a config object for a backend.

Examples:

Request syntax with placeholder values


resp = client.create_backend_config({
  app_id: "__string", # required
  backend_manager_app_id: "__string",
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.job_id #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_manager_app_id (String)

Returns:

See Also:



810
811
812
813
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 810

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

#create_backend_storage(params = {}) ⇒ Types::CreateBackendStorageResponse

Creates a backend storage resource.

Examples:

Request syntax with placeholder values


resp = client.create_backend_storage({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: { # required
    bucket_name: "__string",
    permissions: { # required
      authenticated: ["READ"], # required, accepts READ, CREATE_AND_UPDATE, DELETE
      un_authenticated: ["READ"], # accepts READ, CREATE_AND_UPDATE, DELETE
    },
    service_name: "S3", # required, accepts S3
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.job_id #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (required, Types::CreateBackendStorageResourceConfig) —

    The resource configuration for creating backend storage.

  • :resource_name (required, String)

Returns:

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 860

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

#create_token(params = {}) ⇒ Types::CreateTokenResponse

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Examples:

Request syntax with placeholder values


resp = client.create_token({
  app_id: "__string", # required
})

Response structure


resp.app_id #=> String
resp.challenge_code #=> String
resp.session_id #=> String
resp.ttl #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)

Returns:

See Also:



894
895
896
897
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 894

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

#delete_backend(params = {}) ⇒ Types::DeleteBackendResponse

Removes an existing environment from your Amplify project.

Examples:

Request syntax with placeholder values


resp = client.delete_backend({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)

Returns:

See Also:



934
935
936
937
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 934

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

#delete_backend_api(params = {}) ⇒ Types::DeleteBackendAPIResponse

Deletes an existing backend API resource.

Examples:

Request syntax with placeholder values


resp = client.delete_backend_api({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: {
    additional_auth_types: [
      {
        mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
        settings: {
          cognito_user_pool_id: "__string",
          description: "__string",
          expiration_time: 1.0,
          open_id_auth_ttl: "__string",
          open_id_client_id: "__string",
          open_id_iat_ttl: "__string",
          open_id_issue_url: "__string",
          open_id_provider_name: "__string",
        },
      },
    ],
    api_name: "__string",
    conflict_resolution: {
      resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
    },
    default_auth_type: {
      mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      settings: {
        cognito_user_pool_id: "__string",
        description: "__string",
        expiration_time: 1.0,
        open_id_auth_ttl: "__string",
        open_id_client_id: "__string",
        open_id_iat_ttl: "__string",
        open_id_issue_url: "__string",
        open_id_provider_name: "__string",
      },
    },
    service: "__string",
    transform_schema: "__string",
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (Types::BackendAPIResourceConfig) —

    The resource config for the data model, configured as a part of the Amplify project.

  • :resource_name (required, String)

Returns:

See Also:



1017
1018
1019
1020
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1017

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

#delete_backend_auth(params = {}) ⇒ Types::DeleteBackendAuthResponse

Deletes an existing backend authentication resource.

Examples:

Request syntax with placeholder values


resp = client.delete_backend_auth({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_name (required, String)

Returns:

See Also:



1060
1061
1062
1063
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1060

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

#delete_backend_storage(params = {}) ⇒ Types::DeleteBackendStorageResponse

Removes the specified backend storage resource.

Examples:

Request syntax with placeholder values


resp = client.delete_backend_storage({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_name: "__string", # required
  service_name: "S3", # required, accepts S3
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.job_id #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_name (required, String)
  • :service_name (required, String)

Returns:

See Also:



1102
1103
1104
1105
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1102

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

#delete_token(params = {}) ⇒ Types::DeleteTokenResponse

Deletes the challenge token based on the given appId and sessionId.

Examples:

Request syntax with placeholder values


resp = client.delete_token({
  app_id: "__string", # required
  session_id: "__string", # required
})

Response structure


resp.is_success #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :session_id (required, String)

Returns:

See Also:



1132
1133
1134
1135
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1132

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

#generate_backend_api_models(params = {}) ⇒ Types::GenerateBackendAPIModelsResponse

Generates a model schema for an existing backend API resource.

Examples:

Request syntax with placeholder values


resp = client.generate_backend_api_models({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_name (required, String)

Returns:

See Also:



1175
1176
1177
1178
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1175

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

#get_backend(params = {}) ⇒ Types::GetBackendResponse

Provides project-level details for your Amplify UI project.

Examples:

Request syntax with placeholder values


resp = client.get_backend({
  app_id: "__string", # required
  backend_environment_name: "__string",
})

Response structure


resp.amplify_feature_flags #=> String
resp.amplify_meta_config #=> String
resp.app_id #=> String
resp.app_name #=> String
resp.backend_environment_list #=> Array
resp.backend_environment_list[0] #=> String
resp.backend_environment_name #=> String
resp.error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (String)

Returns:

See Also:



1218
1219
1220
1221
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1218

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

#get_backend_api(params = {}) ⇒ Types::GetBackendAPIResponse

Gets the details for a backend API.

Examples:

Request syntax with placeholder values


resp = client.get_backend_api({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: {
    additional_auth_types: [
      {
        mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
        settings: {
          cognito_user_pool_id: "__string",
          description: "__string",
          expiration_time: 1.0,
          open_id_auth_ttl: "__string",
          open_id_client_id: "__string",
          open_id_iat_ttl: "__string",
          open_id_issue_url: "__string",
          open_id_provider_name: "__string",
        },
      },
    ],
    api_name: "__string",
    conflict_resolution: {
      resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
    },
    default_auth_type: {
      mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      settings: {
        cognito_user_pool_id: "__string",
        description: "__string",
        expiration_time: 1.0,
        open_id_auth_ttl: "__string",
        open_id_client_id: "__string",
        open_id_iat_ttl: "__string",
        open_id_issue_url: "__string",
        open_id_provider_name: "__string",
      },
    },
    service: "__string",
    transform_schema: "__string",
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.resource_config.additional_auth_types #=> Array
resp.resource_config.additional_auth_types[0].mode #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT"
resp.resource_config.additional_auth_types[0].settings.cognito_user_pool_id #=> String
resp.resource_config.additional_auth_types[0].settings.description #=> String
resp.resource_config.additional_auth_types[0].settings.expiration_time #=> Float
resp.resource_config.additional_auth_types[0].settings.open_id_auth_ttl #=> String
resp.resource_config.additional_auth_types[0].settings.open_id_client_id #=> String
resp.resource_config.additional_auth_types[0].settings.open_id_iat_ttl #=> String
resp.resource_config.additional_auth_types[0].settings.open_id_issue_url #=> String
resp.resource_config.additional_auth_types[0].settings.open_id_provider_name #=> String
resp.resource_config.api_name #=> String
resp.resource_config.conflict_resolution.resolution_strategy #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
resp.resource_config.default_auth_type.mode #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT"
resp.resource_config.default_auth_type.settings.cognito_user_pool_id #=> String
resp.resource_config.default_auth_type.settings.description #=> String
resp.resource_config.default_auth_type.settings.expiration_time #=> Float
resp.resource_config.default_auth_type.settings.open_id_auth_ttl #=> String
resp.resource_config.default_auth_type.settings.open_id_client_id #=> String
resp.resource_config.default_auth_type.settings.open_id_iat_ttl #=> String
resp.resource_config.default_auth_type.settings.open_id_issue_url #=> String
resp.resource_config.default_auth_type.settings.open_id_provider_name #=> String
resp.resource_config.service #=> String
resp.resource_config.transform_schema #=> String
resp.resource_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (Types::BackendAPIResourceConfig) —

    The resource config for the data model, configured as a part of the Amplify project.

  • :resource_name (required, String)

Returns:

See Also:



1321
1322
1323
1324
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1321

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

#get_backend_api_models(params = {}) ⇒ Types::GetBackendAPIModelsResponse

Gets a model introspection schema for an existing backend API resource.

Examples:

Request syntax with placeholder values


resp = client.get_backend_api_models({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_name: "__string", # required
})

Response structure


resp.models #=> String
resp.status #=> String, one of "LATEST", "STALE"
resp.model_introspection_schema #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_name (required, String)

Returns:

See Also:



1359
1360
1361
1362
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1359

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

#get_backend_auth(params = {}) ⇒ Types::GetBackendAuthResponse

Gets a backend auth details.

Examples:

Request syntax with placeholder values


resp = client.get_backend_auth({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.resource_config.auth_resources #=> String, one of "USER_POOL_ONLY", "IDENTITY_POOL_AND_USER_POOL"
resp.resource_config.identity_pool_configs.identity_pool_name #=> String
resp.resource_config.identity_pool_configs. #=> Boolean
resp.resource_config.service #=> String, one of "COGNITO"
resp.resource_config.user_pool_configs.forgot_password.delivery_method #=> String, one of "EMAIL", "SMS"
resp.resource_config.user_pool_configs.forgot_password.email_settings.email_message #=> String
resp.resource_config.user_pool_configs.forgot_password.email_settings.email_subject #=> String
resp.resource_config.user_pool_configs.forgot_password.sms_settings.sms_message #=> String
resp.resource_config.user_pool_configs.mfa.mfa_mode #=> String, one of "ON", "OFF", "OPTIONAL"
resp.resource_config.user_pool_configs.mfa.settings.mfa_types #=> Array
resp.resource_config.user_pool_configs.mfa.settings.mfa_types[0] #=> String, one of "SMS", "TOTP"
resp.resource_config.user_pool_configs.mfa.settings.sms_message #=> String
resp.resource_config.user_pool_configs.o_auth.domain_prefix #=> String
resp.resource_config.user_pool_configs.o_auth.o_auth_grant_type #=> String, one of "CODE", "IMPLICIT"
resp.resource_config.user_pool_configs.o_auth.o_auth_scopes #=> Array
resp.resource_config.user_pool_configs.o_auth.o_auth_scopes[0] #=> String, one of "PHONE", "EMAIL", "OPENID", "PROFILE", "AWS_COGNITO_SIGNIN_USER_ADMIN"
resp.resource_config.user_pool_configs.o_auth. #=> Array
resp.resource_config.user_pool_configs.o_auth.[0] #=> String
resp.resource_config.user_pool_configs.o_auth.redirect_sign_out_ur_is #=> Array
resp.resource_config.user_pool_configs.o_auth.redirect_sign_out_ur_is[0] #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings.facebook.client_id #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings.facebook.client_secret #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings.google.client_id #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings.google.client_secret #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings..client_id #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings..client_secret #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings..client_id #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings..key_id #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings..private_key #=> String
resp.resource_config.user_pool_configs.o_auth.social_provider_settings..team_id #=> String
resp.resource_config.user_pool_configs.password_policy.additional_constraints #=> Array
resp.resource_config.user_pool_configs.password_policy.additional_constraints[0] #=> String, one of "REQUIRE_DIGIT", "REQUIRE_LOWERCASE", "REQUIRE_SYMBOL", "REQUIRE_UPPERCASE"
resp.resource_config.user_pool_configs.password_policy.minimum_length #=> Float
resp.resource_config.user_pool_configs. #=> Array
resp.resource_config.user_pool_configs.[0] #=> String, one of "ADDRESS", "BIRTHDATE", "EMAIL", "FAMILY_NAME", "GENDER", "GIVEN_NAME", "LOCALE", "MIDDLE_NAME", "NAME", "NICKNAME", "PHONE_NUMBER", "PICTURE", "PREFERRED_USERNAME", "PROFILE", "UPDATED_AT", "WEBSITE", "ZONE_INFO"
resp.resource_config.user_pool_configs. #=> String, one of "EMAIL", "EMAIL_AND_PHONE_NUMBER", "PHONE_NUMBER", "USERNAME"
resp.resource_config.user_pool_configs.user_pool_name #=> String
resp.resource_config.user_pool_configs.verification_message.delivery_method #=> String, one of "EMAIL", "SMS"
resp.resource_config.user_pool_configs.verification_message.email_settings.email_message #=> String
resp.resource_config.user_pool_configs.verification_message.email_settings.email_subject #=> String
resp.resource_config.user_pool_configs.verification_message.sms_settings.sms_message #=> String
resp.resource_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_name (required, String)

Returns:

See Also:



1440
1441
1442
1443
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1440

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

#get_backend_job(params = {}) ⇒ Types::GetBackendJobResponse

Returns information about a specific job.

Examples:

Request syntax with placeholder values


resp = client.get_backend_job({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  job_id: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.create_time #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String
resp.update_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :job_id (required, String)

Returns:

See Also:



1487
1488
1489
1490
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1487

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

#get_backend_storage(params = {}) ⇒ Types::GetBackendStorageResponse

Gets details for a backend storage resource.

Examples:

Request syntax with placeholder values


resp = client.get_backend_storage({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.resource_config.bucket_name #=> String
resp.resource_config.imported #=> Boolean
resp.resource_config.permissions.authenticated #=> Array
resp.resource_config.permissions.authenticated[0] #=> String, one of "READ", "CREATE_AND_UPDATE", "DELETE"
resp.resource_config.permissions.un_authenticated #=> Array
resp.resource_config.permissions.un_authenticated[0] #=> String, one of "READ", "CREATE_AND_UPDATE", "DELETE"
resp.resource_config.service_name #=> String, one of "S3"
resp.resource_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_name (required, String)

Returns:

See Also:



1532
1533
1534
1535
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1532

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

#get_token(params = {}) ⇒ Types::GetTokenResponse

Gets the challenge token based on the given appId and sessionId.

Examples:

Request syntax with placeholder values


resp = client.get_token({
  app_id: "__string", # required
  session_id: "__string", # required
})

Response structure


resp.app_id #=> String
resp.challenge_code #=> String
resp.session_id #=> String
resp.ttl #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :session_id (required, String)

Returns:

See Also:



1568
1569
1570
1571
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1568

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

#import_backend_auth(params = {}) ⇒ Types::ImportBackendAuthResponse

Imports an existing backend authentication resource.

Examples:

Request syntax with placeholder values


resp = client.import_backend_auth({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  identity_pool_id: "__string",
  native_client_id: "__string", # required
  user_pool_id: "__string", # required
  web_client_id: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :identity_pool_id (String)
  • :native_client_id (required, String)
  • :user_pool_id (required, String)
  • :web_client_id (required, String)

Returns:

See Also:



1620
1621
1622
1623
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1620

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

#import_backend_storage(params = {}) ⇒ Types::ImportBackendStorageResponse

Imports an existing backend storage resource.

Examples:

Request syntax with placeholder values


resp = client.import_backend_storage({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  bucket_name: "__string",
  service_name: "S3", # required, accepts S3
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.job_id #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :bucket_name (String)
  • :service_name (required, String)

Returns:

See Also:



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

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

#list_backend_jobs(params = {}) ⇒ Types::ListBackendJobsResponse

Lists the jobs for the backend of an Amplify app.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_backend_jobs({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  job_id: "__string",
  max_results: 1,
  next_token: "__string",
  operation: "__string",
  status: "__string",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].app_id #=> String
resp.jobs[0].backend_environment_name #=> String
resp.jobs[0].create_time #=> String
resp.jobs[0].error #=> String
resp.jobs[0].job_id #=> String
resp.jobs[0].operation #=> String
resp.jobs[0].status #=> String
resp.jobs[0].update_time #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :job_id (String)
  • :max_results (Integer)
  • :next_token (String)
  • :operation (String)
  • :status (String)

Returns:

See Also:



1719
1720
1721
1722
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1719

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

#list_s3_buckets(params = {}) ⇒ Types::ListS3BucketsResponse

The list of S3 buckets in your account.

Examples:

Request syntax with placeholder values


resp = client.list_s3_buckets({
  next_token: "__string",
})

Response structure


resp.buckets #=> Array
resp.buckets[0].creation_date #=> String
resp.buckets[0].name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

Returns:

See Also:



1750
1751
1752
1753
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1750

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

#remove_all_backends(params = {}) ⇒ Types::RemoveAllBackendsResponse

Removes all backend environments from your Amplify project.

Examples:

Request syntax with placeholder values


resp = client.remove_all_backends({
  app_id: "__string", # required
  clean_amplify_app: false,
})

Response structure


resp.app_id #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :clean_amplify_app (Boolean)

Returns:

See Also:



1788
1789
1790
1791
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1788

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

#remove_backend_config(params = {}) ⇒ Types::RemoveBackendConfigResponse

Removes the AWS resources required to access the Amplify Admin UI.

Examples:

Request syntax with placeholder values


resp = client.remove_backend_config({
  app_id: "__string", # required
})

Response structure


resp.error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)

Returns:

See Also:



1815
1816
1817
1818
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1815

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

#update_backend_api(params = {}) ⇒ Types::UpdateBackendAPIResponse

Updates an existing backend API resource.

Examples:

Request syntax with placeholder values


resp = client.update_backend_api({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: {
    additional_auth_types: [
      {
        mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
        settings: {
          cognito_user_pool_id: "__string",
          description: "__string",
          expiration_time: 1.0,
          open_id_auth_ttl: "__string",
          open_id_client_id: "__string",
          open_id_iat_ttl: "__string",
          open_id_issue_url: "__string",
          open_id_provider_name: "__string",
        },
      },
    ],
    api_name: "__string",
    conflict_resolution: {
      resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
    },
    default_auth_type: {
      mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      settings: {
        cognito_user_pool_id: "__string",
        description: "__string",
        expiration_time: 1.0,
        open_id_auth_ttl: "__string",
        open_id_client_id: "__string",
        open_id_iat_ttl: "__string",
        open_id_issue_url: "__string",
        open_id_provider_name: "__string",
      },
    },
    service: "__string",
    transform_schema: "__string",
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (Types::BackendAPIResourceConfig) —

    The resource config for the data model, configured as a part of the Amplify project.

  • :resource_name (required, String)

Returns:

See Also:



1898
1899
1900
1901
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1898

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

#update_backend_auth(params = {}) ⇒ Types::UpdateBackendAuthResponse

Updates an existing backend authentication resource.

Examples:

Request syntax with placeholder values


resp = client.update_backend_auth({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: { # required
    auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
    identity_pool_configs: {
      unauthenticated_login: false,
    },
    service: "COGNITO", # required, accepts COGNITO
    user_pool_configs: { # required
      forgot_password: {
        delivery_method: "EMAIL", # accepts EMAIL, SMS
        email_settings: {
          email_message: "__string",
          email_subject: "__string",
        },
        sms_settings: {
          sms_message: "__string",
        },
      },
      mfa: {
        mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
        settings: {
          mfa_types: ["SMS"], # accepts SMS, TOTP
          sms_message: "__string",
        },
      },
      o_auth: {
        domain_prefix: "__string",
        o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
        o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
        redirect_sign_in_ur_is: ["__string"],
        redirect_sign_out_ur_is: ["__string"],
        social_provider_settings: {
          facebook: {
            client_id: "__string",
            client_secret: "__string",
          },
          google: {
            client_id: "__string",
            client_secret: "__string",
          },
          login_with_amazon: {
            client_id: "__string",
            client_secret: "__string",
          },
          sign_in_with_apple: {
            client_id: "__string",
            key_id: "__string",
            private_key: "__string",
            team_id: "__string",
          },
        },
      },
      password_policy: {
        additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
        minimum_length: 1.0,
      },
      verification_message: {
        delivery_method: "EMAIL", # required, accepts EMAIL, SMS
        email_settings: {
          email_message: "__string",
          email_subject: "__string",
        },
        sms_settings: {
          sms_message: "__string",
        },
      },
    },
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (required, Types::UpdateBackendAuthResourceConfig) —

    Defines the resource configuration when updating an authentication resource in your Amplify project.

  • :resource_name (required, String)

Returns:

See Also:



2012
2013
2014
2015
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2012

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

#update_backend_config(params = {}) ⇒ Types::UpdateBackendConfigResponse

Updates the AWS resources required to access the Amplify Admin UI.

Examples:

Request syntax with placeholder values


resp = client.update_backend_config({
  app_id: "__string", # required
  login_auth_config: {
    aws_cognito_identity_pool_id: "__string",
    aws_cognito_region: "__string",
    aws_user_pools_id: "__string",
    aws_user_pools_web_client_id: "__string",
  },
})

Response structure


resp.app_id #=> String
resp.backend_manager_app_id #=> String
resp.error #=> String
resp..aws_cognito_identity_pool_id #=> String
resp..aws_cognito_region #=> String
resp..aws_user_pools_id #=> String
resp..aws_user_pools_web_client_id #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



2057
2058
2059
2060
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2057

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

#update_backend_job(params = {}) ⇒ Types::UpdateBackendJobResponse

Updates a specific job.

Examples:

Request syntax with placeholder values


resp = client.update_backend_job({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  job_id: "__string", # required
  operation: "__string",
  status: "__string",
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.create_time #=> String
resp.error #=> String
resp.job_id #=> String
resp.operation #=> String
resp.status #=> String
resp.update_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :job_id (required, String)
  • :operation (String)
  • :status (String)

Returns:

See Also:



2110
2111
2112
2113
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2110

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

#update_backend_storage(params = {}) ⇒ Types::UpdateBackendStorageResponse

Updates an existing backend storage resource.

Examples:

Request syntax with placeholder values


resp = client.update_backend_storage({
  app_id: "__string", # required
  backend_environment_name: "__string", # required
  resource_config: { # required
    permissions: { # required
      authenticated: ["READ"], # required, accepts READ, CREATE_AND_UPDATE, DELETE
      un_authenticated: ["READ"], # accepts READ, CREATE_AND_UPDATE, DELETE
    },
    service_name: "S3", # required, accepts S3
  },
  resource_name: "__string", # required
})

Response structure


resp.app_id #=> String
resp.backend_environment_name #=> String
resp.job_id #=> String
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :app_id (required, String)
  • :backend_environment_name (required, String)
  • :resource_config (required, Types::UpdateBackendStorageResourceConfig) —

    The resource configuration for updating backend storage.

  • :resource_name (required, String)

Returns:

See Also:



2159
2160
2161
2162
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2159

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