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, a list of the roles that Roles Anywhere service is trusted to assume.
-
#create_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).
-
#delete_attribute_mapping(params = {}) ⇒ Types::DeleteAttributeMappingResponse
Delete an entry from the attribute mapping rules enforced by a given profile.
-
#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 temporary credential requests for a profile.
-
#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, which associates a certificate identity with authentication attempts.
-
#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 certificate revocation lists (CRL) 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.
-
#put_attribute_mapping(params = {}) ⇒ Types::PutAttributeMappingResponse
Put an entry in the attribute mapping rules that will be enforced by a given profile.
-
#put_notification_settings(params = {}) ⇒ Types::PutNotificationSettingsResponse
Attaches a list of notification settings to a trust anchor.
-
#reset_notification_settings(params = {}) ⇒ Types::ResetNotificationSettingsResponse
Resets the custom notification setting to IAM Roles Anywhere default setting.
-
#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 a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.
-
#update_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Updates 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.
466 467 468 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#create_profile(params = {}) ⇒ Types::ProfileDetailResponse
Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions: rolesanywhere:CreateProfile
.
566 567 568 569 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 566 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions: rolesanywhere:CreateTrustAnchor
.
649 650 651 652 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 649 def create_trust_anchor(params = {}, = {}) req = build_request(:create_trust_anchor, params) req.send_request() end |
#delete_attribute_mapping(params = {}) ⇒ Types::DeleteAttributeMappingResponse
Delete an entry from the attribute mapping rules enforced by a given profile.
706 707 708 709 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 706 def delete_attribute_mapping(params = {}, = {}) req = build_request(:delete_attribute_mapping, params) req.send_request() end |
#delete_crl(params = {}) ⇒ Types::CrlDetailResponse
Deletes a certificate revocation list (CRL).
Required permissions: rolesanywhere:DeleteCrl
.
743 744 745 746 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 743 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
.
791 792 793 794 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 791 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
.
835 836 837 838 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 835 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
.
872 873 874 875 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 872 def disable_crl(params = {}, = {}) req = build_request(:disable_crl, params) req.send_request() end |
#disable_profile(params = {}) ⇒ Types::ProfileDetailResponse
Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions: rolesanywhere:DisableProfile
.
921 922 923 924 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 921 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, temporary credential requests specifying this trust anchor are unauthorized.
Required permissions: rolesanywhere:DisableTrustAnchor
.
966 967 968 969 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 966 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
.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1005 def enable_crl(params = {}, = {}) req = build_request(:enable_crl, params) req.send_request() end |
#enable_profile(params = {}) ⇒ Types::ProfileDetailResponse
Enables temporary credential requests for a profile.
Required permissions: rolesanywhere:EnableProfile
.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1053 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
.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1098 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
.
1135 1136 1137 1138 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1135 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
.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1183 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_subject(params = {}) ⇒ Types::SubjectDetailResponse
Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the 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
.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1235 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
.
1279 1280 1281 1282 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1279 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). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions: rolesanywhere:ImportCrl
.
1342 1343 1344 1345 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1342 def import_crl(params = {}, = {}) req = build_request(:import_crl, params) req.send_request() end |
#list_crls(params = {}) ⇒ Types::ListCrlsResponse
Lists all certificate revocation lists (CRL) 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.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1391 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.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1451 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.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1499 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
.
1531 1532 1533 1534 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1531 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.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1587 def list_trust_anchors(params = {}, = {}) req = build_request(:list_trust_anchors, params) req.send_request() end |
#put_attribute_mapping(params = {}) ⇒ Types::PutAttributeMappingResponse
Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1648 def put_attribute_mapping(params = {}, = {}) req = build_request(:put_attribute_mapping, params) req.send_request() end |
#put_notification_settings(params = {}) ⇒ Types::PutNotificationSettingsResponse
Attaches a list of notification settings to a trust anchor.
A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.
Required permissions: rolesanywhere:PutNotificationSettings
.
1707 1708 1709 1710 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1707 def put_notification_settings(params = {}, = {}) req = build_request(:put_notification_settings, params) req.send_request() end |
#reset_notification_settings(params = {}) ⇒ Types::ResetNotificationSettingsResponse
Resets the custom notification setting to IAM Roles Anywhere default setting.
Required permissions:
rolesanywhere:ResetNotificationSettings
.
1763 1764 1765 1766 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1763 def reset_notification_settings(params = {}, = {}) req = build_request(:reset_notification_settings, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Attaches tags to a resource.
Required permissions: rolesanywhere:TagResource
.
1796 1797 1798 1799 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1796 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
.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1824 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). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials.
Required permissions: rolesanywhere:UpdateCrl
.
1872 1873 1874 1875 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1872 def update_crl(params = {}, = {}) req = build_request(:update_crl, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::ProfileDetailResponse
Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
Required permissions: rolesanywhere:UpdateProfile
.
1957 1958 1959 1960 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1957 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |
#update_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse
Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.
Required permissions: rolesanywhere:UpdateTrustAnchor
.
2021 2022 2023 2024 |
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 2021 def update_trust_anchor(params = {}, = {}) req = build_request(:update_trust_anchor, params) req.send_request() end |