Class: Aws::Artifact::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Artifact::Client
- 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
- .identifier ⇒ Object readonly private
API Operations collapse
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Get the account settings for Artifact.
-
#get_report(params = {}) ⇒ Types::GetReportResponse
Get the content for a single report.
-
#get_report_metadata(params = {}) ⇒ Types::GetReportMetadataResponse
Get the metadata for a single report.
-
#get_term_for_report(params = {}) ⇒ Types::GetTermForReportResponse
Get the Term content associated with a single report.
-
#list_reports(params = {}) ⇒ Types::ListReportsResponse
List available reports.
-
#put_account_settings(params = {}) ⇒ Types::PutAccountSettingsResponse
Put the account settings for Artifact.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'lib/aws-sdk-artifact/client.rb', line 444 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (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_module ⇒ 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.
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.
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.
479 480 481 482 |
# File 'lib/aws-sdk-artifact/client.rb', line 479 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_report(params = {}) ⇒ Types::GetReportResponse
Get the content for a single report.
533 534 535 536 |
# File 'lib/aws-sdk-artifact/client.rb', line 533 def get_report(params = {}, = {}) req = build_request(:get_report, params) req.send_request() end |
#get_report_metadata(params = {}) ⇒ Types::GetReportMetadataResponse
Get the metadata for a single report.
614 615 616 617 |
# File 'lib/aws-sdk-artifact/client.rb', line 614 def (params = {}, = {}) req = build_request(:get_report_metadata, params) req.send_request() end |
#get_term_for_report(params = {}) ⇒ Types::GetTermForReportResponse
Get the Term content associated with a single report.
664 665 666 667 |
# File 'lib/aws-sdk-artifact/client.rb', line 664 def get_term_for_report(params = {}, = {}) req = build_request(:get_term_for_report, params) req.send_request() 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.
744 745 746 747 |
# File 'lib/aws-sdk-artifact/client.rb', line 744 def list_reports(params = {}, = {}) req = build_request(:list_reports, params) req.send_request() end |
#put_account_settings(params = {}) ⇒ Types::PutAccountSettingsResponse
Put the account settings for Artifact.
788 789 790 791 |
# File 'lib/aws-sdk-artifact/client.rb', line 788 def put_account_settings(params = {}, = {}) req = build_request(:put_account_settings, params) req.send_request() end |
#waiter_names ⇒ 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.
817 818 819 |
# File 'lib/aws-sdk-artifact/client.rb', line 817 def waiter_names [] end |