Class: Aws::Proton::Client

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

Overview

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

client = Aws::Proton::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):

  • :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::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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails or Aws::ECSCredentials 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 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)
  • :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.

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

  • :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 or custom endpoints. This should be a valid 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.

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

  • :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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

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

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



334
335
336
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#accept_environment_account_connection(params = {}) ⇒ Types::AcceptEnvironmentAccountConnectionOutput

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

For more information, see Environment account connections in the AWS Proton Administrator guide.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "EnvironmentAccountConnectionId", # required
})

Response structure


resp..arn #=> String
resp.. #=> String
resp..environment_name #=> String
resp..id #=> String
resp..last_modified_at #=> Time
resp.. #=> String
resp..requested_at #=> Time
resp..role_arn #=> String
resp..status #=> String, one of "PENDING", "CONNECTED", "REJECTED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the environment account connection.

Returns:

See Also:



381
382
383
384
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 381

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

#cancel_environment_deployment(params = {}) ⇒ Types::CancelEnvironmentDeploymentOutput

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the AWS Proton Administrator guide.

The following list includes potential cancellation scenarios.

  • If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

  • If the cancellation attempt fails, the resulting deployment state is FAILED.

  • If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Examples:

Request syntax with placeholder values


resp = client.cancel_environment_deployment({
  environment_name: "ResourceName", # required
})

Response structure


resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.environment.deployment_status_message #=> String
resp.environment.description #=> String
resp.environment. #=> String
resp.environment. #=> String
resp.environment.last_deployment_attempted_at #=> Time
resp.environment.last_deployment_succeeded_at #=> Time
resp.environment.name #=> String
resp.environment.proton_service_role_arn #=> String
resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment.spec #=> String
resp.environment.template_major_version #=> String
resp.environment.template_minor_version #=> String
resp.environment.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_name (required, String)

    The name of the environment with the deployment to cancel.

Returns:

See Also:



442
443
444
445
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 442

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

#cancel_service_instance_deployment(params = {}) ⇒ Types::CancelServiceInstanceDeploymentOutput

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the AWS Proton Administrator guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

  • If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

  • If the cancellation attempt fails, the resulting deployment state is FAILED.

  • If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Examples:

Request syntax with placeholder values


resp = client.cancel_service_instance_deployment({
  service_instance_name: "ResourceName", # required
  service_name: "ResourceName", # required
})

Response structure


resp.service_instance.arn #=> String
resp.service_instance.created_at #=> Time
resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service_instance.deployment_status_message #=> String
resp.service_instance.environment_name #=> String
resp.service_instance.last_deployment_attempted_at #=> Time
resp.service_instance.last_deployment_succeeded_at #=> Time
resp.service_instance.name #=> String
resp.service_instance.service_name #=> String
resp.service_instance.spec #=> String
resp.service_instance.template_major_version #=> String
resp.service_instance.template_minor_version #=> String
resp.service_instance.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_instance_name (required, String)

    The name of the service instance with the deployment to cancel.

  • :service_name (required, String)

    The name of the service with the service instance deployment to cancel.

Returns:

See Also:



507
508
509
510
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 507

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

#cancel_service_pipeline_deployment(params = {}) ⇒ Types::CancelServicePipelineDeploymentOutput

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administrator guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

  • If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

  • If the cancellation attempt fails, the resulting deployment state is FAILED.

  • If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Examples:

Request syntax with placeholder values


resp = client.cancel_service_pipeline_deployment({
  service_name: "ResourceName", # required
})

Response structure


resp.pipeline.arn #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.pipeline.deployment_status_message #=> String
resp.pipeline.last_deployment_attempted_at #=> Time
resp.pipeline.last_deployment_succeeded_at #=> Time
resp.pipeline.spec #=> String
resp.pipeline.template_major_version #=> String
resp.pipeline.template_minor_version #=> String
resp.pipeline.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_name (required, String)

    The name of the service with the service pipeline deployment to cancel.

Returns:

See Also:



565
566
567
568
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 565

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

#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput

Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the Environments in the AWS Proton Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  description: "Description",
  environment_account_connection_id: "EnvironmentAccountConnectionId",
  name: "ResourceName", # required
  proton_service_role_arn: "Arn",
  spec: "SpecContents", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  template_major_version: "TemplateVersionPart", # required
  template_minor_version: "TemplateVersionPart",
  template_name: "ResourceName", # required
})

Response structure


resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.environment.deployment_status_message #=> String
resp.environment.description #=> String
resp.environment. #=> String
resp.environment. #=> String
resp.environment.last_deployment_attempted_at #=> Time
resp.environment.last_deployment_succeeded_at #=> Time
resp.environment.name #=> String
resp.environment.proton_service_role_arn #=> String
resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment.spec #=> String
resp.environment.template_major_version #=> String
resp.environment.template_minor_version #=> String
resp.environment.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description of the environment that's being created and deployed.

  • :environment_account_connection_id (String)

    The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. For more information, see Environment account connections in the AWS Proton Administrator guide.

  • :name (required, String)

    The name of the environment.

  • :proton_service_role_arn (String)

    The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value.

  • :spec (required, String)

    A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administrator Guide.

  • :tags (Array<Types::Tag>)

    Create tags for your environment. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

  • :template_major_version (required, String)

    The ID of the major version of the environment template.

  • :template_minor_version (String)

    The ID of the minor version of the environment template.

  • :template_name (required, String)

    The name of the environment template. For more information, see Environment Templates in the AWS Proton Administrator Guide.

Returns:

See Also:



682
683
684
685
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 682

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

#create_environment_account_connection(params = {}) ⇒ Types::CreateEnvironmentAccountConnectionOutput

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the AWS Proton Administrator guide.

Examples:

Request syntax with placeholder values


resp = client.({
  client_token: "ClientToken",
  environment_name: "ResourceName", # required
  management_account_id: "AwsAccountId", # required
  role_arn: "Arn", # required
})

Response structure


resp..arn #=> String
resp.. #=> String
resp..environment_name #=> String
resp..id #=> String
resp..last_modified_at #=> Time
resp.. #=> String
resp..requested_at #=> Time
resp..role_arn #=> String
resp..status #=> String, one of "PENDING", "CONNECTED", "REJECTED"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    When included, if two identicial requests are made with the same client token, AWS Proton returns the environment account connection that the first request created.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :environment_name (required, String)

    The name of the AWS Proton environment that's created in the associated management account.

  • :management_account_id (required, String)

    The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.

Returns:

See Also:



755
756
757
758
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 755

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

#create_environment_template(params = {}) ⇒ Types::CreateEnvironmentTemplateOutput

Create an environment template for AWS Proton. For more information, see Environment Templates in the AWS Proton Administrator Guide.

You can create an environment template in one of the two following ways:

  • Register and publish a standard environment template that instructs AWS Proton to deploy and manage environment infrastructure.

  • Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the AWS Proton Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_environment_template({
  description: "Description",
  display_name: "DisplayName",
  encryption_key: "Arn",
  name: "ResourceName", # required
  provisioning: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.environment_template.arn #=> String
resp.environment_template.created_at #=> Time
resp.environment_template.description #=> String
resp.environment_template.display_name #=> String
resp.environment_template.encryption_key #=> String
resp.environment_template.last_modified_at #=> Time
resp.environment_template.name #=> String
resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description of the environment template.

  • :display_name (String)

    The environment template name as displayed in the developer interface.

  • :encryption_key (String)

    A customer provided encryption key that AWS Proton uses to encrypt data.

  • :name (required, String)

    The name of the environment template.

  • :provisioning (String)

    When included, indicates that the environment template is for customer provisioned and managed infrastructure.

  • :tags (Array<Types::Tag>)

    Create tags for your environment template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Returns:

See Also:



848
849
850
851
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 848

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

#create_environment_template_version(params = {}) ⇒ Types::CreateEnvironmentTemplateVersionOutput

Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.

Examples:

Request syntax with placeholder values


resp = client.create_environment_template_version({
  client_token: "ClientToken",
  description: "Description",
  major_version: "TemplateVersionPart",
  source: { # required
    s3: {
      bucket: "S3Bucket", # required
      key: "S3Key", # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  template_name: "ResourceName", # required
})

Response structure


resp.environment_template_version.arn #=> String
resp.environment_template_version.created_at #=> Time
resp.environment_template_version.description #=> String
resp.environment_template_version.last_modified_at #=> Time
resp.environment_template_version.major_version #=> String
resp.environment_template_version.minor_version #=> String
resp.environment_template_version.recommended_minor_version #=> String
resp.environment_template_version.schema #=> String
resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.environment_template_version.status_message #=> String
resp.environment_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    When included, if two identicial requests are made with the same client token, AWS Proton returns the environment template version that the first request created.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String)

    A description of the new version of an environment template.

  • :major_version (String)

    To create a new minor version of the environment template, include a majorVersion.

    To create a new major and minor version of the environment template, exclude majorVersion.

  • :source (required, Types::TemplateVersionSourceInput)

    An object that includes the template bundle S3 bucket path and name for the new version of an template.

  • :tags (Array<Types::Tag>)

    Create tags for a new version of an environment template.

  • :template_name (required, String)

    The name of the environment template.

Returns:

See Also:



929
930
931
932
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 929

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

#create_service(params = {}) ⇒ Types::CreateServiceOutput

Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the AWS Proton Administrator Guide and Services in the AWS Proton User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_service({
  branch_name: "GitBranchName",
  description: "Description",
  name: "ResourceName", # required
  repository_connection_arn: "Arn",
  repository_id: "RepositoryId",
  spec: "SpecContents", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  template_major_version: "TemplateVersionPart", # required
  template_minor_version: "TemplateVersionPart",
  template_name: "ResourceName", # required
})

Response structure


resp.service.arn #=> String
resp.service.branch_name #=> String
resp.service.created_at #=> Time
resp.service.description #=> String
resp.service.last_modified_at #=> Time
resp.service.name #=> String
resp.service.pipeline.arn #=> String
resp.service.pipeline.created_at #=> Time
resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service.pipeline.deployment_status_message #=> String
resp.service.pipeline.last_deployment_attempted_at #=> Time
resp.service.pipeline.last_deployment_succeeded_at #=> Time
resp.service.pipeline.spec #=> String
resp.service.pipeline.template_major_version #=> String
resp.service.pipeline.template_minor_version #=> String
resp.service.pipeline.template_name #=> String
resp.service.repository_connection_arn #=> String
resp.service.repository_id #=> String
resp.service.spec #=> String
resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
resp.service.status_message #=> String
resp.service.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :branch_name (String)

    The name of the code repository branch that holds the code that's deployed in AWS Proton. Don't include this parameter if your service template doesn't include a service pipeline.

  • :description (String)

    A description of the AWS Proton service.

  • :name (required, String)

    The service name.

  • :repository_connection_arn (String)

    The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the AWS Proton Administrator Guide and Setting up with AWS Proton in the AWS Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

  • :repository_id (String)

    The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

  • :spec (required, String)

    A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the AWS Proton Administrator Guide and Create a service in the AWS Proton User Guide.

  • :tags (Array<Types::Tag>)

    Create tags for your service. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

  • :template_major_version (required, String)

    The ID of the major version of the service template that was used to create the service.

  • :template_minor_version (String)

    The ID of the minor version of the service template that was used to create the service.

  • :template_name (required, String)

    The name of the service template that's used to create the service.

Returns:

See Also:



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

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

#create_service_template(params = {}) ⇒ Types::CreateServiceTemplateOutput

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the AWS Proton Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_service_template({
  description: "Description",
  display_name: "DisplayName",
  encryption_key: "Arn",
  name: "ResourceName", # required
  pipeline_provisioning: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.service_template.arn #=> String
resp.service_template.created_at #=> Time
resp.service_template.description #=> String
resp.service_template.display_name #=> String
resp.service_template.encryption_key #=> String
resp.service_template.last_modified_at #=> Time
resp.service_template.name #=> String
resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.service_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description of the service template.

  • :display_name (String)

    The name of the service template as displayed in the developer interface.

  • :encryption_key (String)

    A customer provided encryption key that's used to encrypt data.

  • :name (required, String)

    The name of the service template.

  • :pipeline_provisioning (String)

    AWS Proton includes a service pipeline for your service by default. When included, this parameter indicates that an AWS Proton service pipeline won't be included for your service. Once specified, this parameter can't be changed. For more information, see Service template bundles in the AWS Proton Administrator Guide.

  • :tags (Array<Types::Tag>)

    Create tags for your service template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Returns:

See Also:



1147
1148
1149
1150
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1147

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

#create_service_template_version(params = {}) ⇒ Types::CreateServiceTemplateVersionOutput

Create a new major or minor version of a service template. A major version of a service template is a version that isn't backwards compatible. A minor version of a service template is a version that's backwards compatible within its major version.

Examples:

Request syntax with placeholder values


resp = client.create_service_template_version({
  client_token: "ClientToken",
  compatible_environment_templates: [ # required
    {
      major_version: "TemplateVersionPart", # required
      template_name: "ResourceName", # required
    },
  ],
  description: "Description",
  major_version: "TemplateVersionPart",
  source: { # required
    s3: {
      bucket: "S3Bucket", # required
      key: "S3Key", # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  template_name: "ResourceName", # required
})

Response structure


resp.service_template_version.arn #=> String
resp.service_template_version.compatible_environment_templates #=> Array
resp.service_template_version.compatible_environment_templates[0].major_version #=> String
resp.service_template_version.compatible_environment_templates[0].template_name #=> String
resp.service_template_version.created_at #=> Time
resp.service_template_version.description #=> String
resp.service_template_version.last_modified_at #=> Time
resp.service_template_version.major_version #=> String
resp.service_template_version.minor_version #=> String
resp.service_template_version.recommended_minor_version #=> String
resp.service_template_version.schema #=> String
resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.service_template_version.status_message #=> String
resp.service_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

    When included, if two identicial requests are made with the same client token, AWS Proton returns the service template version that the first request created.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :compatible_environment_templates (required, Array<Types::CompatibleEnvironmentTemplateInput>)

    An array of compatible environment template objects for the new version of a service template.

  • :description (String)

    A description of the new version of a service template.

  • :major_version (String)

    To create a new minor version of the service template, include a majorVersion.

    To create a new major and minor version of the service template, exclude majorVersion.

  • :source (required, Types::TemplateVersionSourceInput)

    An object that includes the template bundle S3 bucket path and name for the new version of a service template.

  • :tags (Array<Types::Tag>)

    Create tags for a new version of a service template.

  • :template_name (required, String)

    The name of the service template.

Returns:

See Also:



1241
1242
1243
1244
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1241

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

#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentOutput

Delete an environment.

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  name: "ResourceName", # required
})

Response structure


resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.environment.deployment_status_message #=> String
resp.environment.description #=> String
resp.environment. #=> String
resp.environment. #=> String
resp.environment.last_deployment_attempted_at #=> Time
resp.environment.last_deployment_succeeded_at #=> Time
resp.environment.name #=> String
resp.environment.proton_service_role_arn #=> String
resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment.spec #=> String
resp.environment.template_major_version #=> String
resp.environment.template_minor_version #=> String
resp.environment.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the environment to delete.

Returns:

See Also:



1284
1285
1286
1287
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1284

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

#delete_environment_account_connection(params = {}) ⇒ Types::DeleteEnvironmentAccountConnectionOutput

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an AWS Proton environment, AWS Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.

For more information, see Environment account connections in the AWS Proton Administrator guide.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "EnvironmentAccountConnectionId", # required
})

Response structure


resp..arn #=> String
resp.. #=> String
resp..environment_name #=> String
resp..id #=> String
resp..last_modified_at #=> Time
resp.. #=> String
resp..requested_at #=> Time
resp..role_arn #=> String
resp..status #=> String, one of "PENDING", "CONNECTED", "REJECTED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the environment account connection to delete.

Returns:

See Also:



1334
1335
1336
1337
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1334

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

#delete_environment_template(params = {}) ⇒ Types::DeleteEnvironmentTemplateOutput

If no other major or minor versions of an environment template exist, delete the environment template.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_template({
  name: "ResourceName", # required
})

Response structure


resp.environment_template.arn #=> String
resp.environment_template.created_at #=> Time
resp.environment_template.description #=> String
resp.environment_template.display_name #=> String
resp.environment_template.encryption_key #=> String
resp.environment_template.last_modified_at #=> Time
resp.environment_template.name #=> String
resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the environment template to delete.

Returns:

See Also:



1371
1372
1373
1374
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1371

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

#delete_environment_template_version(params = {}) ⇒ Types::DeleteEnvironmentTemplateVersionOutput

If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backwards compatible.

Delete a minor version of an environment template if it isn't the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backwards compatible.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_template_version({
  major_version: "TemplateVersionPart", # required
  minor_version: "TemplateVersionPart", # required
  template_name: "ResourceName", # required
})

Response structure


resp.environment_template_version.arn #=> String
resp.environment_template_version.created_at #=> Time
resp.environment_template_version.description #=> String
resp.environment_template_version.last_modified_at #=> Time
resp.environment_template_version.major_version #=> String
resp.environment_template_version.minor_version #=> String
resp.environment_template_version.recommended_minor_version #=> String
resp.environment_template_version.schema #=> String
resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.environment_template_version.status_message #=> String
resp.environment_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :major_version (required, String)

    The environment template major version to delete.

  • :minor_version (required, String)

    The environment template minor version to delete.

  • :template_name (required, String)

    The name of the environment template.

Returns:

See Also:



1428
1429
1430
1431
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1428

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

#delete_service(params = {}) ⇒ Types::DeleteServiceOutput

Delete a service.

Examples:

Request syntax with placeholder values


resp = client.delete_service({
  name: "ResourceName", # required
})

Response structure


resp.service.arn #=> String
resp.service.branch_name #=> String
resp.service.created_at #=> Time
resp.service.description #=> String
resp.service.last_modified_at #=> Time
resp.service.name #=> String
resp.service.pipeline.arn #=> String
resp.service.pipeline.created_at #=> Time
resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service.pipeline.deployment_status_message #=> String
resp.service.pipeline.last_deployment_attempted_at #=> Time
resp.service.pipeline.last_deployment_succeeded_at #=> Time
resp.service.pipeline.spec #=> String
resp.service.pipeline.template_major_version #=> String
resp.service.pipeline.template_minor_version #=> String
resp.service.pipeline.template_name #=> String
resp.service.repository_connection_arn #=> String
resp.service.repository_id #=> String
resp.service.spec #=> String
resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
resp.service.status_message #=> String
resp.service.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the service to delete.

Returns:

See Also:



1477
1478
1479
1480
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1477

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

#delete_service_template(params = {}) ⇒ Types::DeleteServiceTemplateOutput

If no other major or minor versions of the service template exist, delete the service template.

Examples:

Request syntax with placeholder values


resp = client.delete_service_template({
  name: "ResourceName", # required
})

Response structure


resp.service_template.arn #=> String
resp.service_template.created_at #=> Time
resp.service_template.description #=> String
resp.service_template.display_name #=> String
resp.service_template.encryption_key #=> String
resp.service_template.last_modified_at #=> Time
resp.service_template.name #=> String
resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.service_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the service template to delete.

Returns:

See Also:



1514
1515
1516
1517
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1514

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

#delete_service_template_version(params = {}) ⇒ Types::DeleteServiceTemplateVersionOutput

If no other minor versions of a service template exist, delete a major version of the service template if it's not the Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn't backwards compatible.

Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible.

Examples:

Request syntax with placeholder values


resp = client.delete_service_template_version({
  major_version: "TemplateVersionPart", # required
  minor_version: "TemplateVersionPart", # required
  template_name: "ResourceName", # required
})

Response structure


resp.service_template_version.arn #=> String
resp.service_template_version.compatible_environment_templates #=> Array
resp.service_template_version.compatible_environment_templates[0].major_version #=> String
resp.service_template_version.compatible_environment_templates[0].template_name #=> String
resp.service_template_version.created_at #=> Time
resp.service_template_version.description #=> String
resp.service_template_version.last_modified_at #=> Time
resp.service_template_version.major_version #=> String
resp.service_template_version.minor_version #=> String
resp.service_template_version.recommended_minor_version #=> String
resp.service_template_version.schema #=> String
resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.service_template_version.status_message #=> String
resp.service_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :major_version (required, String)

    The service template major version to delete.

  • :minor_version (required, String)

    The service template minor version to delete.

  • :template_name (required, String)

    The name of the service template.

Returns:

See Also:



1574
1575
1576
1577
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1574

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

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsOutput

Get detail data for the AWS Proton pipeline service role.

Examples:

Response structure


resp..pipeline_service_role_arn #=> String

Parameters:

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

    ({})

Returns:

See Also:



1593
1594
1595
1596
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1593

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

#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput

Get detail data for an environment.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • environment_deployed

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  name: "ResourceName", # required
})

Response structure


resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.environment.deployment_status_message #=> String
resp.environment.description #=> String
resp.environment. #=> String
resp.environment. #=> String
resp.environment.last_deployment_attempted_at #=> Time
resp.environment.last_deployment_succeeded_at #=> Time
resp.environment.name #=> String
resp.environment.proton_service_role_arn #=> String
resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment.spec #=> String
resp.environment.template_major_version #=> String
resp.environment.template_minor_version #=> String
resp.environment.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the environment that you want to get the detail data for.

Returns:

See Also:



1641
1642
1643
1644
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1641

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

#get_environment_account_connection(params = {}) ⇒ Types::GetEnvironmentAccountConnectionOutput

In an environment account, view the detail data for an environment account connection.

For more information, see Environment account connections in the AWS Proton Administrator guide.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "EnvironmentAccountConnectionId", # required
})

Response structure


resp..arn #=> String
resp.. #=> String
resp..environment_name #=> String
resp..id #=> String
resp..last_modified_at #=> Time
resp.. #=> String
resp..requested_at #=> Time
resp..role_arn #=> String
resp..status #=> String, one of "PENDING", "CONNECTED", "REJECTED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the environment account connection.

Returns:

See Also:



1685
1686
1687
1688
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1685

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

#get_environment_template(params = {}) ⇒ Types::GetEnvironmentTemplateOutput

Get detail data for an environment template.

Examples:

Request syntax with placeholder values


resp = client.get_environment_template({
  name: "ResourceName", # required
})

Response structure


resp.environment_template.arn #=> String
resp.environment_template.created_at #=> Time
resp.environment_template.description #=> String
resp.environment_template.display_name #=> String
resp.environment_template.encryption_key #=> String
resp.environment_template.last_modified_at #=> Time
resp.environment_template.name #=> String
resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the environment template that you want to get the detail data for.

Returns:

See Also:



1722
1723
1724
1725
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1722

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

#get_environment_template_version(params = {}) ⇒ Types::GetEnvironmentTemplateVersionOutput

View detail data for a major or minor version of an environment template.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • environment_template_version_registered

Examples:

Request syntax with placeholder values


resp = client.get_environment_template_version({
  major_version: "TemplateVersionPart", # required
  minor_version: "TemplateVersionPart", # required
  template_name: "ResourceName", # required
})

Response structure


resp.environment_template_version.arn #=> String
resp.environment_template_version.created_at #=> Time
resp.environment_template_version.description #=> String
resp.environment_template_version.last_modified_at #=> Time
resp.environment_template_version.major_version #=> String
resp.environment_template_version.minor_version #=> String
resp.environment_template_version.recommended_minor_version #=> String
resp.environment_template_version.schema #=> String
resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.environment_template_version.status_message #=> String
resp.environment_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :major_version (required, String)

    To view environment template major version detail data, include majorVersion.

  • :minor_version (required, String)

    To view environment template minor version detail data, include minorVersion.

  • :template_name (required, String)

    The name of the environment template.

Returns:

See Also:



1776
1777
1778
1779
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1776

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

#get_service(params = {}) ⇒ Types::GetServiceOutput

Get detail data for a service.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • service_created
  • service_deleted
  • service_pipeline_deployed
  • service_updated

Examples:

Request syntax with placeholder values


resp = client.get_service({
  name: "ResourceName", # required
})

Response structure


resp.service.arn #=> String
resp.service.branch_name #=> String
resp.service.created_at #=> Time
resp.service.description #=> String
resp.service.last_modified_at #=> Time
resp.service.name #=> String
resp.service.pipeline.arn #=> String
resp.service.pipeline.created_at #=> Time
resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service.pipeline.deployment_status_message #=> String
resp.service.pipeline.last_deployment_attempted_at #=> Time
resp.service.pipeline.last_deployment_succeeded_at #=> Time
resp.service.pipeline.spec #=> String
resp.service.pipeline.template_major_version #=> String
resp.service.pipeline.template_minor_version #=> String
resp.service.pipeline.template_name #=> String
resp.service.repository_connection_arn #=> String
resp.service.repository_id #=> String
resp.service.spec #=> String
resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
resp.service.status_message #=> String
resp.service.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the service that you want to get the detail data for.

Returns:

See Also:



1833
1834
1835
1836
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1833

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

#get_service_instance(params = {}) ⇒ Types::GetServiceInstanceOutput

Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • service_instance_deployed

Examples:

Request syntax with placeholder values


resp = client.get_service_instance({
  name: "ResourceName", # required
  service_name: "ResourceName", # required
})

Response structure


resp.service_instance.arn #=> String
resp.service_instance.created_at #=> Time
resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service_instance.deployment_status_message #=> String
resp.service_instance.environment_name #=> String
resp.service_instance.last_deployment_attempted_at #=> Time
resp.service_instance.last_deployment_succeeded_at #=> Time
resp.service_instance.name #=> String
resp.service_instance.service_name #=> String
resp.service_instance.spec #=> String
resp.service_instance.template_major_version #=> String
resp.service_instance.template_minor_version #=> String
resp.service_instance.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of a service instance that you want to get the detail data for.

  • :service_name (required, String)

    The name of the service that the service instance belongs to.

Returns:

See Also:



1885
1886
1887
1888
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1885

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

#get_service_template(params = {}) ⇒ Types::GetServiceTemplateOutput

Get detail data for a service template.

Examples:

Request syntax with placeholder values


resp = client.get_service_template({
  name: "ResourceName", # required
})

Response structure


resp.service_template.arn #=> String
resp.service_template.created_at #=> Time
resp.service_template.description #=> String
resp.service_template.display_name #=> String
resp.service_template.encryption_key #=> String
resp.service_template.last_modified_at #=> Time
resp.service_template.name #=> String
resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.service_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the service template that you want to get detail data for.

Returns:

See Also:



1921
1922
1923
1924
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1921

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

#get_service_template_version(params = {}) ⇒ Types::GetServiceTemplateVersionOutput

View detail data for a major or minor version of a service template.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • service_template_version_registered

Examples:

Request syntax with placeholder values


resp = client.get_service_template_version({
  major_version: "TemplateVersionPart", # required
  minor_version: "TemplateVersionPart", # required
  template_name: "ResourceName", # required
})

Response structure


resp.service_template_version.arn #=> String
resp.service_template_version.compatible_environment_templates #=> Array
resp.service_template_version.compatible_environment_templates[0].major_version #=> String
resp.service_template_version.compatible_environment_templates[0].template_name #=> String
resp.service_template_version.created_at #=> Time
resp.service_template_version.description #=> String
resp.service_template_version.last_modified_at #=> Time
resp.service_template_version.major_version #=> String
resp.service_template_version.minor_version #=> String
resp.service_template_version.recommended_minor_version #=> String
resp.service_template_version.schema #=> String
resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.service_template_version.status_message #=> String
resp.service_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :major_version (required, String)

    To view service template major version detail data, include majorVersion.

  • :minor_version (required, String)

    To view service template minor version detail data, include minorVersion.

  • :template_name (required, String)

    The name of the service template.

Returns:

See Also:



1977
1978
1979
1980
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1977

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

#list_environment_account_connections(params = {}) ⇒ Types::ListEnvironmentAccountConnectionsOutput

View a list of environment account connections.

For more information, see Environment account connections in the AWS Proton Administrator guide.

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

Examples:

Request syntax with placeholder values


resp = client.({
  environment_name: "ResourceName",
  max_results: 1,
  next_token: "NextToken",
  requested_by: "MANAGEMENT_ACCOUNT", # required, accepts MANAGEMENT_ACCOUNT, ENVIRONMENT_ACCOUNT
  statuses: ["PENDING"], # accepts PENDING, CONNECTED, REJECTED
})

Response structure


resp. #=> Array
resp.[0].arn #=> String
resp.[0]. #=> String
resp.[0].environment_name #=> String
resp.[0].id #=> String
resp.[0].last_modified_at #=> Time
resp.[0]. #=> String
resp.[0].requested_at #=> Time
resp.[0].role_arn #=> String
resp.[0].status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_name (String)

    The environment name that's associated with each listed environment account connection.

  • :max_results (Integer)

    The maximum number of environment account connections to list.

  • :next_token (String)

    A token to indicate the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.

  • :requested_by (required, String)

    The type of account making the ListEnvironmentAccountConnections request.

  • :statuses (Array<String>)

    The status details for each listed environment account connection.

Returns:

See Also:



2045
2046
2047
2048
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2045

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

#list_environment_template_versions(params = {}) ⇒ Types::ListEnvironmentTemplateVersionsOutput

List major or minor versions of an environment template with detail data.

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_environment_template_versions({
  major_version: "TemplateVersionPart",
  max_results: 1,
  next_token: "NextToken",
  template_name: "ResourceName", # required
})

Response structure


resp.next_token #=> String
resp.template_versions #=> Array
resp.template_versions[0].arn #=> String
resp.template_versions[0].created_at #=> Time
resp.template_versions[0].description #=> String
resp.template_versions[0].last_modified_at #=> Time
resp.template_versions[0].major_version #=> String
resp.template_versions[0].minor_version #=> String
resp.template_versions[0].recommended_minor_version #=> String
resp.template_versions[0].status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.template_versions[0].status_message #=> String
resp.template_versions[0].template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :major_version (String)

    To view a list of minor of versions under a major version of an environment template, include majorVersion.

    To view a list of major versions of an environment template, exclude majorVersion.

  • :max_results (Integer)

    The maximum number of major or minor versions of an environment template to list.

  • :next_token (String)

    A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.

  • :template_name (required, String)

    The name of the environment template.

Returns:

See Also:



2107
2108
2109
2110
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2107

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

#list_environment_templates(params = {}) ⇒ Types::ListEnvironmentTemplatesOutput

List environment templates.

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_environment_templates({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.templates #=> Array
resp.templates[0].arn #=> String
resp.templates[0].created_at #=> Time
resp.templates[0].description #=> String
resp.templates[0].display_name #=> String
resp.templates[0].last_modified_at #=> Time
resp.templates[0].name #=> String
resp.templates[0].provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.templates[0].recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of environment templates to list.

  • :next_token (String)

    A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.

Returns:

See Also:



2153
2154
2155
2156
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2153

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

#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput

List environments with detail data summaries.

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_environments({
  environment_templates: [
    {
      major_version: "TemplateVersionPart", # required
      template_name: "ResourceName", # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.environments #=> Array
resp.environments[0].arn #=> String
resp.environments[0].created_at #=> Time
resp.environments[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.environments[0].deployment_status_message #=> String
resp.environments[0].description #=> String
resp.environments[0]. #=> String
resp.environments[0]. #=> String
resp.environments[0].last_deployment_attempted_at #=> Time
resp.environments[0].last_deployment_succeeded_at #=> Time
resp.environments[0].name #=> String
resp.environments[0].proton_service_role_arn #=> String
resp.environments[0].provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environments[0].template_major_version #=> String
resp.environments[0].template_minor_version #=> String
resp.environments[0].template_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_templates (Array<Types::EnvironmentTemplateFilter>)

    An array of the versions of the environment template.

  • :max_results (Integer)

    The maximum number of environments to list.

  • :next_token (String)

    A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.

Returns:

See Also:



2215
2216
2217
2218
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2215

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

#list_service_instances(params = {}) ⇒ Types::ListServiceInstancesOutput

List service instances with summaries of detail data.

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_service_instances({
  max_results: 1,
  next_token: "NextToken",
  service_name: "ResourceName",
})

Response structure


resp.next_token #=> String
resp.service_instances #=> Array
resp.service_instances[0].arn #=> String
resp.service_instances[0].created_at #=> Time
resp.service_instances[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service_instances[0].deployment_status_message #=> String
resp.service_instances[0].environment_name #=> String
resp.service_instances[0].last_deployment_attempted_at #=> Time
resp.service_instances[0].last_deployment_succeeded_at #=> Time
resp.service_instances[0].name #=> String
resp.service_instances[0].service_name #=> String
resp.service_instances[0].template_major_version #=> String
resp.service_instances[0].template_minor_version #=> String
resp.service_instances[0].template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of service instances to list.

  • :next_token (String)

    A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.

  • :service_name (String)

    The name of the service that the service instance belongs to.

Returns:

See Also:



2269
2270
2271
2272
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2269

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

#list_service_template_versions(params = {}) ⇒ Types::ListServiceTemplateVersionsOutput

List major or minor versions of a service template with detail data.

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_service_template_versions({
  major_version: "TemplateVersionPart",
  max_results: 1,
  next_token: "NextToken",
  template_name: "ResourceName", # required
})

Response structure


resp.next_token #=> String
resp.template_versions #=> Array
resp.template_versions[0].arn #=> String
resp.template_versions[0].created_at #=> Time
resp.template_versions[0].description #=> String
resp.template_versions[0].last_modified_at #=> Time
resp.template_versions[0].major_version #=> String
resp.template_versions[0].minor_version #=> String
resp.template_versions[0].recommended_minor_version #=> String
resp.template_versions[0].status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.template_versions[0].status_message #=> String
resp.template_versions[0].template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :major_version (String)

    To view a list of minor of versions under a major version of a service template, include majorVersion.

    To view a list of major versions of a service template, exclude majorVersion.

  • :max_results (Integer)

    The maximum number of major or minor versions of a service template to list.

  • :next_token (String)

    A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.

  • :template_name (required, String)

    The name of the service template.

Returns:

See Also:



2330
2331
2332
2333
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2330

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

#list_service_templates(params = {}) ⇒ Types::ListServiceTemplatesOutput

List service templates with detail data.

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_service_templates({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.templates #=> Array
resp.templates[0].arn #=> String
resp.templates[0].created_at #=> Time
resp.templates[0].description #=> String
resp.templates[0].display_name #=> String
resp.templates[0].last_modified_at #=> Time
resp.templates[0].name #=> String
resp.templates[0].pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.templates[0].recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of service templates to list.

  • :next_token (String)

    A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.

Returns:

See Also:



2376
2377
2378
2379
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2376

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

#list_services(params = {}) ⇒ Types::ListServicesOutput

List services with summaries of detail data.

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_services({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.services #=> Array
resp.services[0].arn #=> String
resp.services[0].created_at #=> Time
resp.services[0].description #=> String
resp.services[0].last_modified_at #=> Time
resp.services[0].name #=> String
resp.services[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
resp.services[0].status_message #=> String
resp.services[0].template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of services to list.

  • :next_token (String)

    A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.

Returns:

See Also:



2421
2422
2423
2424
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2421

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

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

List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

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_tags_for_resource({
  max_results: 1,
  next_token: "String",
  resource_arn: "Arn", # required
})

Response structure


resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of tags to list.

  • :next_token (String)

    A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource for the listed tags.

Returns:

See Also:



2472
2473
2474
2475
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2472

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

#reject_environment_account_connection(params = {}) ⇒ Types::RejectEnvironmentAccountConnectionOutput

In a management account, reject an environment account connection from another environment account.

After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.

You can’t reject an environment account connection that is connected to an environment.

For more information, see Environment account connections in the AWS Proton Administrator guide.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "EnvironmentAccountConnectionId", # required
})

Response structure


resp..arn #=> String
resp.. #=> String
resp..environment_name #=> String
resp..id #=> String
resp..last_modified_at #=> Time
resp.. #=> String
resp..requested_at #=> Time
resp..role_arn #=> String
resp..status #=> String, one of "PENDING", "CONNECTED", "REJECTED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the environment account connection to reject.

Returns:

See Also:



2523
2524
2525
2526
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2523

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

#tag_resource(params = {}) ⇒ Struct

Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.

  • :tags (required, Array<Types::Tag>)

    An array of resource tags to apply to a resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2562
2563
2564
2565
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2562

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

#untag_resource(params = {}) ⇒ Struct

Remove a tag from a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.

  • :tag_keys (required, Array<String>)

    An array of tag keys indicating the resource tags to be removed from the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2597
2598
2599
2600
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2597

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

#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsOutput

Update the AWS Proton pipeline service account settings.

Examples:

Request syntax with placeholder values


resp = client.({
  pipeline_service_role_arn: "Arn",
})

Response structure


resp..pipeline_service_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_service_role_arn (String)

    The Amazon Resource Name (ARN) of the AWS Proton pipeline service role.

Returns:

See Also:



2626
2627
2628
2629
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2626

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

#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput

Update an environment.

If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.

There are four modes for updating an environment as described in the
following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).

Examples:

Request syntax with placeholder values


resp = client.update_environment({
  deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
  description: "Description",
  environment_account_connection_id: "EnvironmentAccountConnectionId",
  name: "ResourceName", # required
  proton_service_role_arn: "Arn",
  spec: "SpecContents",
  template_major_version: "TemplateVersionPart",
  template_minor_version: "TemplateVersionPart",
})

Response structure


resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.environment.deployment_status_message #=> String
resp.environment.description #=> String
resp.environment. #=> String
resp.environment. #=> String
resp.environment.last_deployment_attempted_at #=> Time
resp.environment.last_deployment_succeeded_at #=> Time
resp.environment.name #=> String
resp.environment.proton_service_role_arn #=> String
resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment.spec #=> String
resp.environment.template_major_version #=> String
resp.environment.template_minor_version #=> String
resp.environment.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :deployment_type (required, String)
    There are four modes for updating an environment as described in the
    following. The deploymentType field defines the mode.

    NONE

    In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

    CURRENT_VERSION

    In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

    MINOR_VERSION

    In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

    MAJOR_VERSION

    In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

  • :description (String)

    A description of the environment update.

  • :environment_account_connection_id (String)

    The ID of the environment account connection.

    You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

  • :name (required, String)

    The name of the environment to update.

  • :proton_service_role_arn (String)

    The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.

  • :spec (String)

    The formatted specification that defines the update.

  • :template_major_version (String)

    The ID of the major version of the environment to update.

  • :template_minor_version (String)

    The ID of the minor version of the environment to update.

Returns:

See Also:



2794
2795
2796
2797
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2794

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

#update_environment_account_connection(params = {}) ⇒ Types::UpdateEnvironmentAccountConnectionOutput

In an environment account, update an environment account connection to use a new IAM role.

For more information, see Environment account connections in the AWS Proton Administrator guide.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "EnvironmentAccountConnectionId", # required
  role_arn: "Arn", # required
})

Response structure


resp..arn #=> String
resp.. #=> String
resp..environment_name #=> String
resp..id #=> String
resp..last_modified_at #=> Time
resp.. #=> String
resp..requested_at #=> Time
resp..role_arn #=> String
resp..status #=> String, one of "PENDING", "CONNECTED", "REJECTED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the environment account connection to update.

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.

Returns:

See Also:



2843
2844
2845
2846
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2843

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

#update_environment_template(params = {}) ⇒ Types::UpdateEnvironmentTemplateOutput

Update an environment template.

Examples:

Request syntax with placeholder values


resp = client.update_environment_template({
  description: "Description",
  display_name: "DisplayName",
  name: "ResourceName", # required
})

Response structure


resp.environment_template.arn #=> String
resp.environment_template.created_at #=> Time
resp.environment_template.description #=> String
resp.environment_template.display_name #=> String
resp.environment_template.encryption_key #=> String
resp.environment_template.last_modified_at #=> Time
resp.environment_template.name #=> String
resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.environment_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description of the environment template update.

  • :display_name (String)

    The name of the environment template to update as displayed in the developer interface.

  • :name (required, String)

    The name of the environment template to update.

Returns:

See Also:



2888
2889
2890
2891
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2888

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

#update_environment_template_version(params = {}) ⇒ Types::UpdateEnvironmentTemplateVersionOutput

Update a major or minor version of an environment template.

Examples:

Request syntax with placeholder values


resp = client.update_environment_template_version({
  description: "Description",
  major_version: "TemplateVersionPart", # required
  minor_version: "TemplateVersionPart", # required
  status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
  template_name: "ResourceName", # required
})

Response structure


resp.environment_template_version.arn #=> String
resp.environment_template_version.created_at #=> Time
resp.environment_template_version.description #=> String
resp.environment_template_version.last_modified_at #=> Time
resp.environment_template_version.major_version #=> String
resp.environment_template_version.minor_version #=> String
resp.environment_template_version.recommended_minor_version #=> String
resp.environment_template_version.schema #=> String
resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.environment_template_version.status_message #=> String
resp.environment_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description of environment template version to update.

  • :major_version (required, String)

    To update a major version of an environment template, include majorVersion.

  • :minor_version (required, String)

    To update a minor version of an environment template, include minorVersion.

  • :status (String)

    The status of the environment template minor version to update.

  • :template_name (required, String)

    The name of the environment template.

Returns:

See Also:



2944
2945
2946
2947
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2944

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

#update_service(params = {}) ⇒ Types::UpdateServiceOutput

Edit a service description or use a spec to add and delete service instances.

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

Examples:

Request syntax with placeholder values


resp = client.update_service({
  description: "Description",
  name: "ResourceName", # required
  spec: "SpecContents",
})

Response structure


resp.service.arn #=> String
resp.service.branch_name #=> String
resp.service.created_at #=> Time
resp.service.description #=> String
resp.service.last_modified_at #=> Time
resp.service.name #=> String
resp.service.pipeline.arn #=> String
resp.service.pipeline.created_at #=> Time
resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service.pipeline.deployment_status_message #=> String
resp.service.pipeline.last_deployment_attempted_at #=> Time
resp.service.pipeline.last_deployment_succeeded_at #=> Time
resp.service.pipeline.spec #=> String
resp.service.pipeline.template_major_version #=> String
resp.service.pipeline.template_minor_version #=> String
resp.service.pipeline.template_name #=> String
resp.service.repository_connection_arn #=> String
resp.service.repository_id #=> String
resp.service.spec #=> String
resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
resp.service.status_message #=> String
resp.service.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    The edited service description.

  • :name (required, String)

    The name of the service to edit.

  • :spec (String)

    Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the AWS Proton Administrator Guide or the AWS Proton User Guide.

Returns:

See Also:



3020
3021
3022
3023
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3020

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

#update_service_instance(params = {}) ⇒ Types::UpdateServiceInstanceOutput

Update a service instance.

There are four modes for updating a service instance as described in
the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

Examples:

Request syntax with placeholder values


resp = client.update_service_instance({
  deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
  name: "ResourceName", # required
  service_name: "ResourceName", # required
  spec: "SpecContents",
  template_major_version: "TemplateVersionPart",
  template_minor_version: "TemplateVersionPart",
})

Response structure


resp.service_instance.arn #=> String
resp.service_instance.created_at #=> Time
resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service_instance.deployment_status_message #=> String
resp.service_instance.environment_name #=> String
resp.service_instance.last_deployment_attempted_at #=> Time
resp.service_instance.last_deployment_succeeded_at #=> Time
resp.service_instance.name #=> String
resp.service_instance.service_name #=> String
resp.service_instance.spec #=> String
resp.service_instance.template_major_version #=> String
resp.service_instance.template_minor_version #=> String
resp.service_instance.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :deployment_type (required, String)

    The deployment type.

    There are four modes for updating a service instance as described in
    the following. The deploymentType field defines the mode.

    NONE

    In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

    CURRENT_VERSION

    In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

    MINOR_VERSION

    In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

    MAJOR_VERSION

    In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

  • :name (required, String)

    The name of the service instance to update.

  • :service_name (required, String)

    The name of the service that the service instance belongs to.

  • :spec (String)

    The formatted specification that defines the service instance update.

  • :template_major_version (String)

    The major version of the service template to update.

  • :template_minor_version (String)

    The minor version of the service template to update.

Returns:

See Also:



3156
3157
3158
3159
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3156

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

#update_service_pipeline(params = {}) ⇒ Types::UpdateServicePipelineOutput

Update the service pipeline.

There are four modes for updating a service pipeline as described in
the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

Examples:

Request syntax with placeholder values


resp = client.update_service_pipeline({
  deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
  service_name: "ResourceName", # required
  spec: "SpecContents", # required
  template_major_version: "TemplateVersionPart",
  template_minor_version: "TemplateVersionPart",
})

Response structure


resp.pipeline.arn #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.pipeline.deployment_status_message #=> String
resp.pipeline.last_deployment_attempted_at #=> Time
resp.pipeline.last_deployment_succeeded_at #=> Time
resp.pipeline.spec #=> String
resp.pipeline.template_major_version #=> String
resp.pipeline.template_minor_version #=> String
resp.pipeline.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :deployment_type (required, String)

    The deployment type.

    There are four modes for updating a service pipeline as described in
    the following. The deploymentType field defines the mode.

    NONE

    In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

    CURRENT_VERSION

    In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

    MINOR_VERSION

    In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

    MAJOR_VERSION

    In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

  • :service_name (required, String)

    The name of the service to that the pipeline is associated with.

  • :spec (required, String)

    The spec for the service pipeline to update.

  • :template_major_version (String)

    The major version of the service template that was used to create the service that the pipeline is associated with.

  • :template_minor_version (String)

    The minor version of the service template that was used to create the service that the pipeline is associated with.

Returns:

See Also:



3287
3288
3289
3290
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3287

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

#update_service_template(params = {}) ⇒ Types::UpdateServiceTemplateOutput

Update a service template.

Examples:

Request syntax with placeholder values


resp = client.update_service_template({
  description: "Description",
  display_name: "DisplayName",
  name: "ResourceName", # required
})

Response structure


resp.service_template.arn #=> String
resp.service_template.created_at #=> Time
resp.service_template.description #=> String
resp.service_template.display_name #=> String
resp.service_template.encryption_key #=> String
resp.service_template.last_modified_at #=> Time
resp.service_template.name #=> String
resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
resp.service_template.recommended_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description of the service template update.

  • :display_name (String)

    The name of the service template to update as displayed in the developer interface.

  • :name (required, String)

    The name of the service template to update.

Returns:

See Also:



3332
3333
3334
3335
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3332

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

#update_service_template_version(params = {}) ⇒ Types::UpdateServiceTemplateVersionOutput

Update a major or minor version of a service template.

Examples:

Request syntax with placeholder values


resp = client.update_service_template_version({
  compatible_environment_templates: [
    {
      major_version: "TemplateVersionPart", # required
      template_name: "ResourceName", # required
    },
  ],
  description: "Description",
  major_version: "TemplateVersionPart", # required
  minor_version: "TemplateVersionPart", # required
  status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
  template_name: "ResourceName", # required
})

Response structure


resp.service_template_version.arn #=> String
resp.service_template_version.compatible_environment_templates #=> Array
resp.service_template_version.compatible_environment_templates[0].major_version #=> String
resp.service_template_version.compatible_environment_templates[0].template_name #=> String
resp.service_template_version.created_at #=> Time
resp.service_template_version.description #=> String
resp.service_template_version.last_modified_at #=> Time
resp.service_template_version.major_version #=> String
resp.service_template_version.minor_version #=> String
resp.service_template_version.recommended_minor_version #=> String
resp.service_template_version.schema #=> String
resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
resp.service_template_version.status_message #=> String
resp.service_template_version.template_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :compatible_environment_templates (Array<Types::CompatibleEnvironmentTemplateInput>)

    An array of compatible environment names for a service template major or minor version to update.

  • :description (String)

    A description of a service template version to update.

  • :major_version (required, String)

    To update a major version of a service template, include majorVersion.

  • :minor_version (required, String)

    To update a minor version of a service template, include minorVersion.

  • :status (String)

    The status of the service template minor version to update.

  • :template_name (required, String)

    The name of the service template.

Returns:

See Also:



3401
3402
3403
3404
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3401

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

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

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

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

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

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

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

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

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

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

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
environment_deployed #get_environment 5 999
environment_template_version_registered #get_environment_template_version 2 150
service_created #get_service 5 999
service_deleted #get_service 5 999
service_instance_deployed #get_service_instance 5 999
service_pipeline_deployed #get_service 10 360
service_template_version_registered #get_service_template_version 2 150
service_updated #get_service 5 999

Parameters:

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

    ({})

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

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

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

  • (Errors::TooManyAttemptsError)

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

  • (Errors::UnexpectedError)

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

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.



3518
3519
3520
3521
3522
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3518

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end