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.

  • :use_dualstack_endpoint (Boolean)

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

  • :use_fips_endpoint (Boolean)

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

  • :validate_params (Boolean) — default: true

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

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



343
344
345
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 343

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



390
391
392
393
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 390

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 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.provisioning_repository.arn #=> String
resp.environment.provisioning_repository.branch #=> String
resp.environment.provisioning_repository.name #=> String
resp.environment.provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
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:



455
456
457
458
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 455

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 Proton Administrator guide or the 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:



520
521
522
523
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 520

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 Proton Administrator guide or the 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:



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

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 Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

  • Standard provisioning: Proton makes direct calls to provision your resources.

  • Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see the Environments in the 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",
  provisioning_repository: {
    branch: "GitBranchName", # required
    name: "RepositoryName", # required
    provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  },
  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.provisioning_repository.arn #=> String
resp.environment.provisioning_repository.branch #=> String
resp.environment.provisioning_repository.name #=> String
resp.environment.provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
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 and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the Proton Administrator guide.

  • :name (required, String)

    The name of the environment.

  • :proton_service_role_arn (String)

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

  • :provisioning_repository (Types::RepositoryBranchInput)

    The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.

  • :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 Proton Administrator Guide.

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

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

  • :template_major_version (required, String)

    The major version of the environment template.

  • :template_minor_version (String)

    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 Proton Administrator Guide.

Returns:

See Also:



732
733
734
735
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 732

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 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
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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 identical requests are made with the same client token, 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 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 Proton environment in this account. If the management account accepts the environment account connection, 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. Proton uses this role to provision infrastructure resources in the associated environment account.

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

    Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide.

Returns:

See Also:



820
821
822
823
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 820

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 Proton. For more information, see Environment Templates in the 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 Proton to deploy and manage environment infrastructure.

  • Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. 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 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 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 Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

Returns:

See Also:



910
911
912
913
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 910

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 identical requests are made with the same client token, 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 major Version.

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

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



991
992
993
994
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 991

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

#create_repository(params = {}) ⇒ Types::CreateRepositoryOutput

Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the Proton Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_repository({
  connection_arn: "Arn", # required
  encryption_key: "Arn",
  name: "RepositoryName", # required
  provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
})

Response structure


resp.repository.arn #=> String
resp.repository.connection_arn #=> String
resp.repository.encryption_key #=> String
resp.repository.name #=> String
resp.repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_arn (required, String)

    The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.

  • :encryption_key (String)

    The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.

  • :name (required, String)

    The repository name, for example myrepos/myrepo.

  • :provider (required, String)

    The repository provider.

Returns:

See Also:



1050
1051
1052
1053
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1050

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

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

Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton Administrator Guide and Services in the 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 Proton. Don't include this parameter if your service template doesn't include a service pipeline.

  • :description (String)

    A description of the 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 Proton Administrator Guide and Setting up with Proton in the 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 Proton Administrator Guide and Create a service in the Proton User Guide.

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

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

  • :template_major_version (required, String)

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

  • :template_minor_version (String)

    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:



1179
1180
1181
1182
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1179

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 Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the 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)

    Proton includes a service pipeline for your service by default. When included, this parameter indicates that an 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 Proton Administrator Guide.

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

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

Returns:

See Also:



1267
1268
1269
1270
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1267

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 backward compatible. A minor version of a service template is a version that's backward 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 identical requests are made with the same client token, 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 major Version.

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

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



1361
1362
1363
1364
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1361

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

#create_template_sync_config(params = {}) ⇒ Types::CreateTemplateSyncConfigOutput

Set up a template for automated template version creation. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_template_sync_config({
  branch: "GitBranchName", # required
  repository_name: "RepositoryName", # required
  repository_provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  subdirectory: "Subdirectory",
  template_name: "ResourceName", # required
  template_type: "ENVIRONMENT", # required, accepts ENVIRONMENT, SERVICE
})

Response structure


resp.template_sync_config.branch #=> String
resp.template_sync_config.repository_name #=> String
resp.template_sync_config.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.template_sync_config.subdirectory #=> String
resp.template_sync_config.template_name #=> String
resp.template_sync_config.template_type #=> String, one of "ENVIRONMENT", "SERVICE"

Parameters:

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

    ({})

Options Hash (params):

  • :branch (required, String)

    The branch of the registered repository for your template.

  • :repository_name (required, String)

    The name of your repository, for example myrepos/myrepo.

  • :repository_provider (required, String)

    The provider type for your repository.

  • :subdirectory (String)

    A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.

  • :template_name (required, String)

    The name of your registered template.

  • :template_type (required, String)

    The type of the registered template.

Returns:

See Also:



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

def create_template_sync_config(params = {}, options = {})
  req = build_request(:create_template_sync_config, 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.provisioning_repository.arn #=> String
resp.environment.provisioning_repository.branch #=> String
resp.environment.provisioning_repository.name #=> String
resp.environment.provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
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:



1474
1475
1476
1477
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1474

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 Proton environment, 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 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:



1524
1525
1526
1527
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1524

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:



1561
1562
1563
1564
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1561

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



1618
1619
1620
1621
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1618

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

#delete_repository(params = {}) ⇒ Types::DeleteRepositoryOutput

De-register and unlink your repository.

Examples:

Request syntax with placeholder values


resp = client.delete_repository({
  name: "RepositoryName", # required
  provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
})

Response structure


resp.repository.arn #=> String
resp.repository.connection_arn #=> String
resp.repository.encryption_key #=> String
resp.repository.name #=> String
resp.repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the repository.

  • :provider (required, String)

    The repository provider.

Returns:

See Also:



1654
1655
1656
1657
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1654

def delete_repository(params = {}, options = {})
  req = build_request(:delete_repository, 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:



1703
1704
1705
1706
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1703

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:



1740
1741
1742
1743
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1740

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:



1800
1801
1802
1803
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1800

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

#delete_template_sync_config(params = {}) ⇒ Types::DeleteTemplateSyncConfigOutput

Delete a template sync configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_template_sync_config({
  template_name: "ResourceName", # required
  template_type: "ENVIRONMENT", # required, accepts ENVIRONMENT, SERVICE
})

Response structure


resp.template_sync_config.branch #=> String
resp.template_sync_config.repository_name #=> String
resp.template_sync_config.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.template_sync_config.subdirectory #=> String
resp.template_sync_config.template_name #=> String
resp.template_sync_config.template_type #=> String, one of "ENVIRONMENT", "SERVICE"

Parameters:

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

    ({})

Options Hash (params):

  • :template_name (required, String)

    The template name.

  • :template_type (required, String)

    The template type.

Returns:

See Also:



1837
1838
1839
1840
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1837

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

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

Get detail data for the Proton pipeline service role.

Examples:

Response structure


resp..pipeline_provisioning_repository.arn #=> String
resp..pipeline_provisioning_repository.branch #=> String
resp..pipeline_provisioning_repository.name #=> String
resp..pipeline_provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp..pipeline_service_role_arn #=> String

Parameters:

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

    ({})

Returns:

See Also:



1860
1861
1862
1863
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1860

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.provisioning_repository.arn #=> String
resp.environment.provisioning_repository.branch #=> String
resp.environment.provisioning_repository.name #=> String
resp.environment.provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
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:



1912
1913
1914
1915
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1912

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



1956
1957
1958
1959
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1956

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:



1993
1994
1995
1996
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 1993

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 major Version.

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



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

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

#get_repository(params = {}) ⇒ Types::GetRepositoryOutput

Get detail data for a repository.

Examples:

Request syntax with placeholder values


resp = client.get_repository({
  name: "RepositoryName", # required
  provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
})

Response structure


resp.repository.arn #=> String
resp.repository.connection_arn #=> String
resp.repository.encryption_key #=> String
resp.repository.name #=> String
resp.repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The repository name, for example myrepos/myrepo.

  • :provider (required, String)

    The repository provider.

Returns:

See Also:



2083
2084
2085
2086
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2083

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

#get_repository_sync_status(params = {}) ⇒ Types::GetRepositorySyncStatusOutput

Get the repository sync status.

Examples:

Request syntax with placeholder values


resp = client.get_repository_sync_status({
  branch: "GitBranchName", # required
  repository_name: "RepositoryName", # required
  repository_provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  sync_type: "TEMPLATE_SYNC", # required, accepts TEMPLATE_SYNC
})

Response structure


resp.latest_sync.events #=> Array
resp.latest_sync.events[0].event #=> String
resp.latest_sync.events[0].external_id #=> String
resp.latest_sync.events[0].time #=> Time
resp.latest_sync.events[0].type #=> String
resp.latest_sync.started_at #=> Time
resp.latest_sync.status #=> String, one of "INITIATED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "QUEUED"

Parameters:

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

    ({})

Options Hash (params):

  • :branch (required, String)

    The repository branch.

  • :repository_name (required, String)

    The repository name.

  • :repository_provider (required, String)

    The repository provider.

  • :sync_type (required, String)

    The repository sync type.

Returns:

See Also:



2129
2130
2131
2132
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2129

def get_repository_sync_status(params = {}, options = {})
  req = build_request(:get_repository_sync_status, 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:



2186
2187
2188
2189
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2186

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:



2238
2239
2240
2241
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2238

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:



2274
2275
2276
2277
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2274

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 major Version.

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



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

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

#get_template_sync_config(params = {}) ⇒ Types::GetTemplateSyncConfigOutput

Get detail data for a template sync configuration.

Examples:

Request syntax with placeholder values


resp = client.get_template_sync_config({
  template_name: "ResourceName", # required
  template_type: "ENVIRONMENT", # required, accepts ENVIRONMENT, SERVICE
})

Response structure


resp.template_sync_config.branch #=> String
resp.template_sync_config.repository_name #=> String
resp.template_sync_config.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.template_sync_config.subdirectory #=> String
resp.template_sync_config.template_name #=> String
resp.template_sync_config.template_type #=> String, one of "ENVIRONMENT", "SERVICE"

Parameters:

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

    ({})

Options Hash (params):

  • :template_name (required, String)

    The template name.

  • :template_type (required, String)

    The template type.

Returns:

See Also:



2367
2368
2369
2370
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2367

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

#get_template_sync_status(params = {}) ⇒ Types::GetTemplateSyncStatusOutput

Get the status of a template sync.

Examples:

Request syntax with placeholder values


resp = client.get_template_sync_status({
  template_name: "ResourceName", # required
  template_type: "ENVIRONMENT", # required, accepts ENVIRONMENT, SERVICE
  template_version: "TemplateVersionPart", # required
})

Response structure


resp.desired_state.branch #=> String
resp.desired_state.directory #=> String
resp.desired_state.repository_name #=> String
resp.desired_state.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.desired_state.sha #=> String
resp.latest_successful_sync.events #=> Array
resp.latest_successful_sync.events[0].event #=> String
resp.latest_successful_sync.events[0].external_id #=> String
resp.latest_successful_sync.events[0].time #=> Time
resp.latest_successful_sync.events[0].type #=> String
resp.latest_successful_sync.initial_revision.branch #=> String
resp.latest_successful_sync.initial_revision.directory #=> String
resp.latest_successful_sync.initial_revision.repository_name #=> String
resp.latest_successful_sync.initial_revision.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.latest_successful_sync.initial_revision.sha #=> String
resp.latest_successful_sync.started_at #=> Time
resp.latest_successful_sync.status #=> String, one of "INITIATED", "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.latest_successful_sync.target #=> String
resp.latest_successful_sync.target_revision.branch #=> String
resp.latest_successful_sync.target_revision.directory #=> String
resp.latest_successful_sync.target_revision.repository_name #=> String
resp.latest_successful_sync.target_revision.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.latest_successful_sync.target_revision.sha #=> String
resp.latest_sync.events #=> Array
resp.latest_sync.events[0].event #=> String
resp.latest_sync.events[0].external_id #=> String
resp.latest_sync.events[0].time #=> Time
resp.latest_sync.events[0].type #=> String
resp.latest_sync.initial_revision.branch #=> String
resp.latest_sync.initial_revision.directory #=> String
resp.latest_sync.initial_revision.repository_name #=> String
resp.latest_sync.initial_revision.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.latest_sync.initial_revision.sha #=> String
resp.latest_sync.started_at #=> Time
resp.latest_sync.status #=> String, one of "INITIATED", "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.latest_sync.target #=> String
resp.latest_sync.target_revision.branch #=> String
resp.latest_sync.target_revision.directory #=> String
resp.latest_sync.target_revision.repository_name #=> String
resp.latest_sync.target_revision.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.latest_sync.target_revision.sha #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :template_name (required, String)

    The template name.

  • :template_type (required, String)

    The template type.

  • :template_version (required, String)

    The template version.

Returns:

See Also:



2445
2446
2447
2448
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2445

def get_template_sync_status(params = {}, options = {})
  req = build_request(:get_template_sync_status, 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 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:



2513
2514
2515
2516
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2513

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

#list_environment_outputs(params = {}) ⇒ Types::ListEnvironmentOutputsOutput

List the infrastructure as code outputs for your environment.

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_outputs({
  environment_name: "ResourceName", # required
  next_token: "EmptyNextToken",
})

Response structure


resp.next_token #=> String
resp.outputs #=> Array
resp.outputs[0].key #=> String
resp.outputs[0].value_string #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_name (required, String)

    The environment name.

  • :next_token (String)

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

Returns:

See Also:



2553
2554
2555
2556
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2553

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

#list_environment_provisioned_resources(params = {}) ⇒ Types::ListEnvironmentProvisionedResourcesOutput

List the provisioned resources for your environment.

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_provisioned_resources({
  environment_name: "ResourceName", # required
  next_token: "EmptyNextToken",
})

Response structure


resp.next_token #=> String
resp.provisioned_resources #=> Array
resp.provisioned_resources[0].identifier #=> String
resp.provisioned_resources[0].name #=> String
resp.provisioned_resources[0].provisioning_engine #=> String, one of "CLOUDFORMATION", "TERRAFORM"

Parameters:

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

    ({})

Options Hash (params):

  • :environment_name (required, String)

    The environment name.

  • :next_token (String)

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

Returns:

See Also:



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

def list_environment_provisioned_resources(params = {}, options = {})
  req = build_request(:list_environment_provisioned_resources, 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 major Version.

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

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



2657
2658
2659
2660
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2657

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:



2703
2704
2705
2706
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2703

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:



2765
2766
2767
2768
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2765

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

#list_repositories(params = {}) ⇒ Types::ListRepositoriesOutput

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

Response structure


resp.next_token #=> String
resp.repositories #=> Array
resp.repositories[0].arn #=> String
resp.repositories[0].name #=> String
resp.repositories[0].provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of repositories to list.

  • :next_token (String)

    A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.

Returns:

See Also:



2805
2806
2807
2808
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2805

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

#list_repository_sync_definitions(params = {}) ⇒ Types::ListRepositorySyncDefinitionsOutput

List repository sync definitions 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_repository_sync_definitions({
  next_token: "EmptyNextToken",
  repository_name: "RepositoryName", # required
  repository_provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  sync_type: "TEMPLATE_SYNC", # required, accepts TEMPLATE_SYNC
})

Response structure


resp.next_token #=> String
resp.sync_definitions #=> Array
resp.sync_definitions[0].branch #=> String
resp.sync_definitions[0].directory #=> String
resp.sync_definitions[0].parent #=> String
resp.sync_definitions[0].target #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.

  • :repository_name (required, String)

    The repository name.

  • :repository_provider (required, String)

    The repository provider.

  • :sync_type (required, String)

    The sync type. The only supported value is TEMPLATE_SYNC.

Returns:

See Also:



2855
2856
2857
2858
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2855

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

#list_service_instance_outputs(params = {}) ⇒ Types::ListServiceInstanceOutputsOutput

View a list service instance infrastructure as code outputs 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_instance_outputs({
  next_token: "EmptyNextToken",
  service_instance_name: "ResourceName", # required
  service_name: "ResourceName", # required
})

Response structure


resp.next_token #=> String
resp.outputs #=> Array
resp.outputs[0].key #=> String
resp.outputs[0].value_string #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :service_instance_name (required, String)

    The service instance name.

  • :service_name (required, String)

    The service name.

Returns:

See Also:



2899
2900
2901
2902
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2899

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

#list_service_instance_provisioned_resources(params = {}) ⇒ Types::ListServiceInstanceProvisionedResourcesOutput

List provisioned resources for a service instance with details.

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_instance_provisioned_resources({
  next_token: "EmptyNextToken",
  service_instance_name: "ResourceName", # required
  service_name: "ResourceName", # required
})

Response structure


resp.next_token #=> String
resp.provisioned_resources #=> Array
resp.provisioned_resources[0].identifier #=> String
resp.provisioned_resources[0].name #=> String
resp.provisioned_resources[0].provisioning_engine #=> String, one of "CLOUDFORMATION", "TERRAFORM"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :service_instance_name (required, String)

    The service instance name.

  • :service_name (required, String)

    The service name.

Returns:

See Also:



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

def list_service_instance_provisioned_resources(params = {}, options = {})
  req = build_request(:list_service_instance_provisioned_resources, 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:



2998
2999
3000
3001
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 2998

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

#list_service_pipeline_outputs(params = {}) ⇒ Types::ListServicePipelineOutputsOutput

View a list service pipeline infrastructure as code outputs with detail.

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_pipeline_outputs({
  next_token: "EmptyNextToken",
  service_name: "ResourceName", # required
})

Response structure


resp.next_token #=> String
resp.outputs #=> Array
resp.outputs[0].key #=> String
resp.outputs[0].value_string #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :service_name (required, String)

    The service name.

Returns:

See Also:



3038
3039
3040
3041
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3038

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

#list_service_pipeline_provisioned_resources(params = {}) ⇒ Types::ListServicePipelineProvisionedResourcesOutput

List provisioned resources for a service and pipeline with details.

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_pipeline_provisioned_resources({
  next_token: "EmptyNextToken",
  service_name: "ResourceName", # required
})

Response structure


resp.next_token #=> String
resp.provisioned_resources #=> Array
resp.provisioned_resources[0].identifier #=> String
resp.provisioned_resources[0].name #=> String
resp.provisioned_resources[0].provisioning_engine #=> String, one of "CLOUDFORMATION", "TERRAFORM"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :service_name (required, String)

    The service name.

Returns:

See Also:



3079
3080
3081
3082
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3079

def list_service_pipeline_provisioned_resources(params = {}, options = {})
  req = build_request(:list_service_pipeline_provisioned_resources, 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 major Version.

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

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



3140
3141
3142
3143
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3140

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:



3186
3187
3188
3189
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3186

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:



3231
3232
3233
3234
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3231

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 Proton resources and tagging in the Proton Administrator Guide or 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:



3282
3283
3284
3285
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3282

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

#notify_resource_deployment_status_change(params = {}) ⇒ Struct

Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.

Examples:

Request syntax with placeholder values


resp = client.notify_resource_deployment_status_change({
  deployment_id: "DeploymentId",
  outputs: [
    {
      key: "OutputKey",
      value_string: "OutputValueString",
    },
  ],
  resource_arn: "Arn", # required
  status: "IN_PROGRESS", # required, accepts IN_PROGRESS, FAILED, SUCCEEDED
  status_message: "SyntheticNotifyResourceDeploymentStatusChangeInputString",
})

Parameters:

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

    ({})

Options Hash (params):

  • :deployment_id (String)

    The deployment ID for your provisioned resource.

  • :outputs (Array<Types::Output>)

    The provisioned resource state change detail data that's returned by Proton.

  • :resource_arn (required, String)

    The provisioned resource Amazon Resource Name (ARN).

  • :status (required, String)

    The status of your provisioned resource.

  • :status_message (String)

    The deployment status message for your provisioned resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3338
3339
3340
3341
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3338

def notify_resource_deployment_status_change(params = {}, options = {})
  req = build_request(:notify_resource_deployment_status_change, 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 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:



3389
3390
3391
3392
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3389

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 Proton resources and tagging in the Proton Administrator Guide or 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:



3428
3429
3430
3431
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3428

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 Proton resources and tagging in the Proton Administrator Guide or 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:



3463
3464
3465
3466
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3463

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

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

Update the Proton service pipeline role or repository settings.

Examples:

Request syntax with placeholder values


resp = client.({
  pipeline_provisioning_repository: {
    branch: "GitBranchName", # required
    name: "RepositoryName", # required
    provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  },
  pipeline_service_role_arn: "PipelineRoleArn",
})

Response structure


resp..pipeline_provisioning_repository.arn #=> String
resp..pipeline_provisioning_repository.branch #=> String
resp..pipeline_provisioning_repository.name #=> String
resp..pipeline_provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp..pipeline_service_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_provisioning_repository (Types::RepositoryBranchInput)

    The repository that you provide with pull request provisioning.

    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.

  • :pipeline_service_role_arn (String)

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

    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.

Returns:

See Also:



3521
3522
3523
3524
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3521

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 and provisioningRepository 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.

If the environment was provisioned with pull request provisioning, include the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.

If the environment wasn't provisioned with pull request provisioning, omit the provisioningRepository parameter.

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",
  provisioning_repository: {
    branch: "GitBranchName", # required
    name: "RepositoryName", # required
    provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  },
  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.provisioning_repository.arn #=> String
resp.environment.provisioning_repository.branch #=> String
resp.environment.provisioning_repository.name #=> String
resp.environment.provisioning_repository.provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
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 Proton service role that allows Proton to make API calls to other services your behalf.

  • :provisioning_repository (Types::RepositoryBranchInput)

    The repository that you provide with pull request provisioning.

    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.

  • :spec (String)

    The formatted specification that defines the update.

  • :template_major_version (String)

    The major version of the environment to update.

  • :template_minor_version (String)

    The minor version of the environment to update.

Returns:

See Also:



3719
3720
3721
3722
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3719

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



3768
3769
3770
3771
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3768

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:



3813
3814
3815
3816
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3813

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 major Version.

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



3869
3870
3871
3872
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3869

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 Proton Administrator Guide or the Proton User Guide.

Returns:

See Also:



3945
3946
3947
3948
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 3945

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:



4081
4082
4083
4084
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4081

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:



4212
4213
4214
4215
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4212

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:



4257
4258
4259
4260
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4257

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 major Version.

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



4326
4327
4328
4329
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4326

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

#update_template_sync_config(params = {}) ⇒ Types::UpdateTemplateSyncConfigOutput

Update template sync configuration parameters, except for the templateName and templateType.

Examples:

Request syntax with placeholder values


resp = client.update_template_sync_config({
  branch: "GitBranchName", # required
  repository_name: "RepositoryName", # required
  repository_provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  subdirectory: "Subdirectory",
  template_name: "ResourceName", # required
  template_type: "ENVIRONMENT", # required, accepts ENVIRONMENT, SERVICE
})

Response structure


resp.template_sync_config.branch #=> String
resp.template_sync_config.repository_name #=> String
resp.template_sync_config.repository_provider #=> String, one of "GITHUB", "GITHUB_ENTERPRISE", "BITBUCKET"
resp.template_sync_config.subdirectory #=> String
resp.template_sync_config.template_name #=> String
resp.template_sync_config.template_type #=> String, one of "ENVIRONMENT", "SERVICE"

Parameters:

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

    ({})

Options Hash (params):

  • :branch (required, String)

    The repository branch.

  • :repository_name (required, String)

    The name of the repository, for example myrepos/myrepo.

  • :repository_provider (required, String)

    The repository provider.

  • :subdirectory (String)

    A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.

  • :template_name (required, String)

    The synced template name.

  • :template_type (required, String)

    The synced template type.

Returns:

See Also:



4381
4382
4383
4384
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4381

def update_template_sync_config(params = {}, options = {})
  req = build_request(:update_template_sync_config, 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.



4498
4499
4500
4501
4502
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb', line 4498

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