Class: Aws::RolesAnywhere::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RolesAnywhere::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb
Overview
An API client for RolesAnywhere. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::RolesAnywhere::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
API Operations collapse
-
#create_profile(params = {}) ⇒ Types::ProfileDetailResponse
Creates a profile.
-
#create_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Creates a trust anchor.
-
#delete_crl(params = {}) ⇒ Types::CrlDetailResponse
Deletes a certificate revocation list (CRL).
-
#delete_profile(params = {}) ⇒ Types::ProfileDetailResponse
Deletes a profile.
-
#delete_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Deletes a trust anchor.
-
#disable_crl(params = {}) ⇒ Types::CrlDetailResponse
Disables a certificate revocation list (CRL).
-
#disable_profile(params = {}) ⇒ Types::ProfileDetailResponse
Disables a profile.
-
#disable_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Disables a trust anchor.
-
#enable_crl(params = {}) ⇒ Types::CrlDetailResponse
Enables a certificate revocation list (CRL).
-
#enable_profile(params = {}) ⇒ Types::ProfileDetailResponse
Enables the roles in a profile to receive session credentials in [CreateSession][1].
-
#enable_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Enables a trust anchor.
-
#get_crl(params = {}) ⇒ Types::CrlDetailResponse
Gets a certificate revocation list (CRL).
-
#get_profile(params = {}) ⇒ Types::ProfileDetailResponse
Gets a profile.
-
#get_subject(params = {}) ⇒ Types::SubjectDetailResponse
Gets a Subject.
-
#get_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Gets a trust anchor.
-
#import_crl(params = {}) ⇒ Types::CrlDetailResponse
Imports the certificate revocation list (CRL).
-
#list_crls(params = {}) ⇒ Types::ListCrlsResponse
Lists all Crls in the authenticated account and Amazon Web Services Region.
-
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Lists all profiles in the authenticated account and Amazon Web Services Region.
-
#list_subjects(params = {}) ⇒ Types::ListSubjectsResponse
Lists the subjects in the authenticated account and Amazon Web Services Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags attached to the resource.
-
#list_trust_anchors(params = {}) ⇒ Types::ListTrustAnchorsResponse
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
-
#tag_resource(params = {}) ⇒ Struct
Attaches tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the resource.
-
#update_crl(params = {}) ⇒ Types::CrlDetailResponse
Updates the certificate revocation list (CRL).
-
#update_profile(params = {}) ⇒ Types::ProfileDetailResponse
Updates the profile.
-
#update_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
365 366 367 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#create_profile(params = {}) ⇒ Types::ProfileDetailResponse
Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.
Required permissions: rolesanywhere:CreateProfile
.
457 458 459 460 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 457 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.
Required permissions: rolesanywhere:CreateTrustAnchor
.
525 526 527 528 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 525 def create_trust_anchor(params = {}, = {}) req = build_request(:create_trust_anchor, params) req.send_request() end |
#delete_crl(params = {}) ⇒ Types::CrlDetailResponse
Deletes a certificate revocation list (CRL).
Required permissions: rolesanywhere:DeleteCrl
.
562 563 564 565 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 562 def delete_crl(params = {}, = {}) req = build_request(:delete_crl, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Types::ProfileDetailResponse
Deletes a profile.
Required permissions: rolesanywhere:DeleteProfile
.
605 606 607 608 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 605 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#delete_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Deletes a trust anchor.
Required permissions: rolesanywhere:DeleteTrustAnchor
.
643 644 645 646 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 643 def delete_trust_anchor(params = {}, = {}) req = build_request(:delete_trust_anchor, params) req.send_request() end |
#disable_crl(params = {}) ⇒ Types::CrlDetailResponse
Disables a certificate revocation list (CRL).
Required permissions: rolesanywhere:DisableCrl
.
680 681 682 683 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 680 def disable_crl(params = {}, = {}) req = build_request(:disable_crl, params) req.send_request() end |
#disable_profile(params = {}) ⇒ Types::ProfileDetailResponse
Disables a profile. When disabled, CreateSession requests with this profile fail.
Required permissions: rolesanywhere:DisableProfile
.
728 729 730 731 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 728 def disable_profile(params = {}, = {}) req = build_request(:disable_profile, params) req.send_request() end |
#disable_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Disables a trust anchor. When disabled, CreateSession requests specifying this trust anchor are unauthorized.
Required permissions: rolesanywhere:DisableTrustAnchor
.
771 772 773 774 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 771 def disable_trust_anchor(params = {}, = {}) req = build_request(:disable_trust_anchor, params) req.send_request() end |
#enable_crl(params = {}) ⇒ Types::CrlDetailResponse
Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.
Required permissions: rolesanywhere:EnableCrl
.
810 811 812 813 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 810 def enable_crl(params = {}, = {}) req = build_request(:enable_crl, params) req.send_request() end |
#enable_profile(params = {}) ⇒ Types::ProfileDetailResponse
Enables the roles in a profile to receive session credentials in CreateSession.
Required permissions: rolesanywhere:EnableProfile
.
858 859 860 861 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 858 def enable_profile(params = {}, = {}) req = build_request(:enable_profile, params) req.send_request() end |
#enable_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions: rolesanywhere:EnableTrustAnchor
.
897 898 899 900 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 897 def enable_trust_anchor(params = {}, = {}) req = build_request(:enable_trust_anchor, params) req.send_request() end |
#get_crl(params = {}) ⇒ Types::CrlDetailResponse
Gets a certificate revocation list (CRL).
Required permissions: rolesanywhere:GetCrl
.
934 935 936 937 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 934 def get_crl(params = {}, = {}) req = build_request(:get_crl, params) req.send_request() end |
#get_profile(params = {}) ⇒ Types::ProfileDetailResponse
Gets a profile.
Required permissions: rolesanywhere:GetProfile
.
977 978 979 980 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 977 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_subject(params = {}) ⇒ Types::SubjectDetailResponse
Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.
Required permissions: rolesanywhere:GetSubject
.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1029 def get_subject(params = {}, = {}) req = build_request(:get_subject, params) req.send_request() end |
#get_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Gets a trust anchor.
Required permissions: rolesanywhere:GetTrustAnchor
.
1067 1068 1069 1070 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1067 def get_trust_anchor(params = {}, = {}) req = build_request(:get_trust_anchor, params) req.send_request() end |
#import_crl(params = {}) ⇒ Types::CrlDetailResponse
Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.
Required permissions: rolesanywhere:ImportCrl
.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1129 def import_crl(params = {}, = {}) req = build_request(:import_crl, params) req.send_request() end |
#list_crls(params = {}) ⇒ Types::ListCrlsResponse
Lists all Crls in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListCrls
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1178 1179 1180 1181 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1178 def list_crls(params = {}, = {}) req = build_request(:list_crls, params) req.send_request() end |
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListProfiles
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1233 1234 1235 1236 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1233 def list_profiles(params = {}, = {}) req = build_request(:list_profiles, params) req.send_request() end |
#list_subjects(params = {}) ⇒ Types::ListSubjectsResponse
Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListSubjects
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1281 def list_subjects(params = {}, = {}) req = build_request(:list_subjects, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags attached to the resource.
Required permissions: rolesanywhere:ListTagsForResource
.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1313 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_trust_anchors(params = {}) ⇒ Types::ListTrustAnchorsResponse
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListTrustAnchors
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1363 1364 1365 1366 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1363 def list_trust_anchors(params = {}, = {}) req = build_request(:list_trust_anchors, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Attaches tags to a resource.
Required permissions: rolesanywhere:TagResource
.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1396 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the resource.
Required permissions: rolesanywhere:UntagResource
.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1424 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_crl(params = {}) ⇒ Types::CrlDetailResponse
Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.
Required permissions: rolesanywhere:UpdateCrl
.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1472 def update_crl(params = {}, = {}) req = build_request(:update_crl, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::ProfileDetailResponse
Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.
Required permissions: rolesanywhere:UpdateProfile
.
1545 1546 1547 1548 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1545 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |
#update_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.
Required permissions: rolesanywhere:UpdateTrustAnchor
.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1604 def update_trust_anchor(params = {}, = {}) req = build_request(:update_trust_anchor, params) req.send_request() end |