Class: Aws::Artifact::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-artifact/client.rb

Overview

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. 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`

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

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

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

  • :region (required, String)

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

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :disable_request_compression (Boolean) — default: false

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

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

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

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean)

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240

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

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

  • :sdk_ua_app_id (String)

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

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

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

  • :stub_responses (Boolean) — default: false

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

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

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

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

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

  • :use_dualstack_endpoint (Boolean)

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

  • :use_fips_endpoint (Boolean)

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

  • :validate_params (Boolean) — default: true

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

  • :endpoint_provider (Aws::Artifact::EndpointProvider)

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60

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

  • :http_wire_trace (Boolean) — default: false

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

  • :on_chunk_received (Proc)

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

  • :on_chunk_sent (Proc)

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

  • :raise_response_errors (Boolean) — default: true

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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

  • :ssl_ca_store (String)

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey)

    Sets a client key when creating http connections.

  • :ssl_timeout (Float)

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true

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



444
445
446
# File 'lib/aws-sdk-artifact/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifierObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



824
825
826
# File 'lib/aws-sdk-artifact/client.rb', line 824

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



827
828
829
# File 'lib/aws-sdk-artifact/client.rb', line 827

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
# File 'lib/aws-sdk-artifact/client.rb', line 797

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Artifact')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-artifact'
  context[:gem_version] = '1.14.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Get the account settings for Artifact.

Examples:

Example: Invoke GetAccountSettings operation


# Get the current account settings.

resp = client.({
})

resp.to_h outputs the following:
{
  account_settings: {
    notification_subscription_status: "SUBSCRIBED", 
  }, 
}

Response structure


resp..notification_subscription_status #=> String, one of "SUBSCRIBED", "NOT_SUBSCRIBED"

Parameters:

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

    ({})

Returns:

See Also:



479
480
481
482
# File 'lib/aws-sdk-artifact/client.rb', line 479

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

#get_report(params = {}) ⇒ Types::GetReportResponse

Get the content for a single report.

Examples:

Example: Invoke GetReport operation on the latest version of a specific report


# The GetReport operation is invoked on a reportId and on a optional version.
# Callers must provide a termToken, which is provided by the GetTermForReport
# operation. If callers do not provide a version, it will default to the
# report's latest version

resp = client.get_report({
  report_id: "report-1hVFddebtfDNJAUf", 
  term_token: "term-token-gPFEGk7CF4wS901w7ppYclt7", 
})

resp.to_h outputs the following:
{
  document_presigned_url: "<Presigned S3 URL>", 
}

Request syntax with placeholder values


resp = client.get_report({
  report_id: "ReportId", # required
  report_version: 1,
  term_token: "ShortStringAttribute", # required
})

Response structure


resp.document_presigned_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :report_id (required, String)

    Unique resource ID for the report resource.

  • :report_version (Integer)

    Version for the report resource.

  • :term_token (required, String)

    Unique download token provided by GetTermForReport API.

Returns:

See Also:



533
534
535
536
# File 'lib/aws-sdk-artifact/client.rb', line 533

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

#get_report_metadata(params = {}) ⇒ Types::GetReportMetadataResponse

Get the metadata for a single report.

Examples:

Example: Invoke GetReportMetadata operation on the latest version of a specific report


# The GetReportMetadata operation is invoked on a reportId and on a optional version.
# If callers do not provide a version, it will default to the report's latest version.

resp = client.({
  report_id: "report-bqhUJF3FrQZsMJpb", 
})

resp.to_h outputs the following:
{
  report_details: {
    version: 1, 
    name: "Name of report", 
    arn: "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb:1", 
    category: "Artifact Category", 
    company_name: "AWS", 
    created_at: Time.parse("2022-05-27T23:17:00.343940Z"), 
    description: "Description of report", 
    id: "report-bqhUJF3FrQZsMJpb", 
    period_end: Time.parse("2022-04-01T20:32:04Z"), 
    period_start: Time.parse("2022-04-01T20:32:04Z"), 
    product_name: "Product of report", 
    series: "Artifact Series", 
    state: "PUBLISHED", 
    term_arn: "arn:aws:artifact:us-east-1::term/term-gLJGG12NyPtYcmtu:1", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  report_id: "ReportId", # required
  report_version: 1,
})

Response structure


resp.report_details.id #=> String
resp.report_details.name #=> String
resp.report_details.description #=> String
resp.report_details.period_start #=> Time
resp.report_details.period_end #=> Time
resp.report_details.created_at #=> Time
resp.report_details.last_modified_at #=> Time
resp.report_details.deleted_at #=> Time
resp.report_details.state #=> String, one of "PUBLISHED", "UNPUBLISHED"
resp.report_details.arn #=> String
resp.report_details.series #=> String
resp.report_details.category #=> String
resp.report_details.company_name #=> String
resp.report_details.product_name #=> String
resp.report_details.term_arn #=> String
resp.report_details.version #=> Integer
resp.report_details.acceptance_type #=> String, one of "PASSTHROUGH", "EXPLICIT"
resp.report_details.sequence_number #=> Integer
resp.report_details.upload_state #=> String, one of "PROCESSING", "COMPLETE", "FAILED", "FAULT"
resp.report_details.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :report_id (required, String)

    Unique resource ID for the report resource.

  • :report_version (Integer)

    Version for the report resource.

Returns:

See Also:



614
615
616
617
# File 'lib/aws-sdk-artifact/client.rb', line 614

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

#get_term_for_report(params = {}) ⇒ Types::GetTermForReportResponse

Get the Term content associated with a single report.

Examples:

Example: Invoke GetTermForReport operation on the latest version of a specific report


# The GetTermForReport operation is invoked on a reportId and on a optional version.
# If callers do not provide a version, it will default to the report's latest version.

resp = client.get_term_for_report({
  report_id: "report-bqhUJF3FrQZsMJpb", 
})

resp.to_h outputs the following:
{
  document_presigned_url: "<Presigned S3 URL>", 
  term_token: "term-token-gPFEGk7CF4wS901w7ppYclt7", 
}

Request syntax with placeholder values


resp = client.get_term_for_report({
  report_id: "ReportId", # required
  report_version: 1,
})

Response structure


resp.document_presigned_url #=> String
resp.term_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :report_id (required, String)

    Unique resource ID for the report resource.

  • :report_version (Integer)

    Version for the report resource.

Returns:

See Also:



664
665
666
667
# File 'lib/aws-sdk-artifact/client.rb', line 664

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

#list_reports(params = {}) ⇒ Types::ListReportsResponse

List available reports.

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

Examples:

Example: Invoke ListReports operation


# The ListReports operation returns a collection of report resources.

resp = client.list_reports({
})

resp.to_h outputs the following:
{
  next_token: "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7", 
  reports: [
    {
      version: 1, 
      name: "Name of report", 
      arn: "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb", 
      category: "Artifact Category", 
      company_name: "AWS", 
      description: "Description of report", 
      id: "report-bqhUJF3FrQZsMJpb", 
      period_end: Time.parse("2022-04-01T20:32:04Z"), 
      period_start: Time.parse("2022-04-01T20:32:04Z"), 
      product_name: "Product of report", 
      series: "Artifact Series", 
      state: "PUBLISHED", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_reports({
  max_results: 1,
  next_token: "NextTokenAttribute",
})

Response structure


resp.reports #=> Array
resp.reports[0].id #=> String
resp.reports[0].name #=> String
resp.reports[0].state #=> String, one of "PUBLISHED", "UNPUBLISHED"
resp.reports[0].arn #=> String
resp.reports[0].version #=> Integer
resp.reports[0].upload_state #=> String, one of "PROCESSING", "COMPLETE", "FAILED", "FAULT"
resp.reports[0].description #=> String
resp.reports[0].period_start #=> Time
resp.reports[0].period_end #=> Time
resp.reports[0].series #=> String
resp.reports[0].category #=> String
resp.reports[0].company_name #=> String
resp.reports[0].product_name #=> String
resp.reports[0].status_message #=> String
resp.reports[0].acceptance_type #=> String, one of "PASSTHROUGH", "EXPLICIT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    Maximum number of resources to return in the paginated response.

  • :next_token (String)

    Pagination token to request the next page of resources.

Returns:

See Also:



744
745
746
747
# File 'lib/aws-sdk-artifact/client.rb', line 744

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

#put_account_settings(params = {}) ⇒ Types::PutAccountSettingsResponse

Put the account settings for Artifact.

Examples:

Example: Invoke PutAccountSettings operation


# Set the account settings.

resp = client.({
  notification_subscription_status: "SUBSCRIBED", 
})

resp.to_h outputs the following:
{
  account_settings: {
    notification_subscription_status: "SUBSCRIBED", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  notification_subscription_status: "SUBSCRIBED", # accepts SUBSCRIBED, NOT_SUBSCRIBED
})

Response structure


resp..notification_subscription_status #=> String, one of "SUBSCRIBED", "NOT_SUBSCRIBED"

Parameters:

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

    ({})

Options Hash (params):

  • :notification_subscription_status (String)

    Desired notification subscription status.

Returns:

See Also:



788
789
790
791
# File 'lib/aws-sdk-artifact/client.rb', line 788

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

#waiter_namesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.


817
818
819
# File 'lib/aws-sdk-artifact/client.rb', line 817

def waiter_names
  []
end