@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIAMRolesAnywhereClient extends AmazonWebServiceClient implements AWSIAMRolesAnywhere
Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of Amazon Web Services to obtain temporary Amazon Web Services credentials. Your workloads can use the same IAM policies and roles you have for native Amazon Web Services applications to access Amazon Web Services resources. Using IAM Roles Anywhere eliminates the need to manage long-term credentials for workloads running outside of Amazon Web Services.
To use IAM Roles Anywhere, your workloads must use X.509 certificates issued by their certificate authority (CA). You register the CA with IAM Roles Anywhere as a trust anchor to establish trust between your public key infrastructure (PKI) and IAM Roles Anywhere. If you don't manage your own PKI system, you can use Private Certificate Authority to create a CA and then use that to establish trust with IAM Roles Anywhere.
This guide describes the IAM Roles Anywhere operations that you can call programmatically. For more information about IAM Roles Anywhere, see the IAM Roles Anywhere User Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSIAMRolesAnywhereClientBuilder |
builder() |
CreateProfileResult |
createProfile(CreateProfileRequest request)
Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.
|
CreateTrustAnchorResult |
createTrustAnchor(CreateTrustAnchorRequest request)
Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).
|
DeleteAttributeMappingResult |
deleteAttributeMapping(DeleteAttributeMappingRequest request)
Delete an entry from the attribute mapping rules enforced by a given profile.
|
DeleteCrlResult |
deleteCrl(DeleteCrlRequest request)
Deletes a certificate revocation list (CRL).
|
DeleteProfileResult |
deleteProfile(DeleteProfileRequest request)
Deletes a profile.
|
DeleteTrustAnchorResult |
deleteTrustAnchor(DeleteTrustAnchorRequest request)
Deletes a trust anchor.
|
DisableCrlResult |
disableCrl(DisableCrlRequest request)
Disables a certificate revocation list (CRL).
|
DisableProfileResult |
disableProfile(DisableProfileRequest request)
Disables a profile.
|
DisableTrustAnchorResult |
disableTrustAnchor(DisableTrustAnchorRequest request)
Disables a trust anchor.
|
EnableCrlResult |
enableCrl(EnableCrlRequest request)
Enables a certificate revocation list (CRL).
|
EnableProfileResult |
enableProfile(EnableProfileRequest request)
Enables temporary credential requests for a profile.
|
EnableTrustAnchorResult |
enableTrustAnchor(EnableTrustAnchorRequest request)
Enables a trust anchor.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCrlResult |
getCrl(GetCrlRequest request)
Gets a certificate revocation list (CRL).
|
GetProfileResult |
getProfile(GetProfileRequest request)
Gets a profile.
|
GetSubjectResult |
getSubject(GetSubjectRequest request)
Gets a subject, which associates a certificate identity with authentication attempts.
|
GetTrustAnchorResult |
getTrustAnchor(GetTrustAnchorRequest request)
Gets a trust anchor.
|
ImportCrlResult |
importCrl(ImportCrlRequest request)
Imports the certificate revocation list (CRL).
|
ListCrlsResult |
listCrls(ListCrlsRequest request)
Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.
|
ListProfilesResult |
listProfiles(ListProfilesRequest request)
Lists all profiles in the authenticated account and Amazon Web Services Region.
|
ListSubjectsResult |
listSubjects(ListSubjectsRequest request)
Lists the subjects in the authenticated account and Amazon Web Services Region.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags attached to the resource.
|
ListTrustAnchorsResult |
listTrustAnchors(ListTrustAnchorsRequest request)
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
|
PutAttributeMappingResult |
putAttributeMapping(PutAttributeMappingRequest request)
Put an entry in the attribute mapping rules that will be enforced by a given profile.
|
PutNotificationSettingsResult |
putNotificationSettings(PutNotificationSettingsRequest request)
Attaches a list of notification settings to a trust anchor.
|
ResetNotificationSettingsResult |
resetNotificationSettings(ResetNotificationSettingsRequest request)
Resets the custom notification setting to IAM Roles Anywhere default setting.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Attaches tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from the resource.
|
UpdateCrlResult |
updateCrl(UpdateCrlRequest request)
Updates the certificate revocation list (CRL).
|
UpdateProfileResult |
updateProfile(UpdateProfileRequest request)
Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.
|
UpdateTrustAnchorResult |
updateTrustAnchor(UpdateTrustAnchorRequest request)
Updates a trust anchor.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSIAMRolesAnywhereClientBuilder builder()
public CreateProfileResult createProfile(CreateProfileRequest request)
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.
createProfile in interface AWSIAMRolesAnywherecreateProfileRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public CreateTrustAnchorResult createTrustAnchor(CreateTrustAnchorRequest request)
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.
createTrustAnchor in interface AWSIAMRolesAnywherecreateTrustAnchorRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public DeleteAttributeMappingResult deleteAttributeMapping(DeleteAttributeMappingRequest request)
Delete an entry from the attribute mapping rules enforced by a given profile.
deleteAttributeMapping in interface AWSIAMRolesAnywheredeleteAttributeMappingRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public DeleteCrlResult deleteCrl(DeleteCrlRequest request)
Deletes a certificate revocation list (CRL).
Required permissions: rolesanywhere:DeleteCrl.
deleteCrl in interface AWSIAMRolesAnywheredeleteCrlRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
Deletes a profile.
Required permissions: rolesanywhere:DeleteProfile.
deleteProfile in interface AWSIAMRolesAnywheredeleteProfileRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public DeleteTrustAnchorResult deleteTrustAnchor(DeleteTrustAnchorRequest request)
Deletes a trust anchor.
Required permissions: rolesanywhere:DeleteTrustAnchor.
deleteTrustAnchor in interface AWSIAMRolesAnywheredeleteTrustAnchorRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public DisableCrlResult disableCrl(DisableCrlRequest request)
Disables a certificate revocation list (CRL).
Required permissions: rolesanywhere:DisableCrl.
disableCrl in interface AWSIAMRolesAnywheredisableCrlRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public DisableProfileResult disableProfile(DisableProfileRequest request)
Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions: rolesanywhere:DisableProfile.
disableProfile in interface AWSIAMRolesAnywheredisableProfileRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public DisableTrustAnchorResult disableTrustAnchor(DisableTrustAnchorRequest request)
Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized.
Required permissions: rolesanywhere:DisableTrustAnchor.
disableTrustAnchor in interface AWSIAMRolesAnywheredisableTrustAnchorRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public EnableCrlResult enableCrl(EnableCrlRequest request)
Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.
Required permissions: rolesanywhere:EnableCrl.
enableCrl in interface AWSIAMRolesAnywhereenableCrlRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public EnableProfileResult enableProfile(EnableProfileRequest request)
Enables temporary credential requests for a profile.
Required permissions: rolesanywhere:EnableProfile.
enableProfile in interface AWSIAMRolesAnywhereenableProfileRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public EnableTrustAnchorResult enableTrustAnchor(EnableTrustAnchorRequest request)
Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions: rolesanywhere:EnableTrustAnchor.
enableTrustAnchor in interface AWSIAMRolesAnywhereenableTrustAnchorRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public GetCrlResult getCrl(GetCrlRequest request)
Gets a certificate revocation list (CRL).
Required permissions: rolesanywhere:GetCrl.
getCrl in interface AWSIAMRolesAnywheregetCrlRequest - ResourceNotFoundException - The resource could not be found.public GetProfileResult getProfile(GetProfileRequest request)
Gets a profile.
Required permissions: rolesanywhere:GetProfile.
getProfile in interface AWSIAMRolesAnywheregetProfileRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public GetSubjectResult getSubject(GetSubjectRequest request)
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.
getSubject in interface AWSIAMRolesAnywheregetSubjectRequest - ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public GetTrustAnchorResult getTrustAnchor(GetTrustAnchorRequest request)
Gets a trust anchor.
Required permissions: rolesanywhere:GetTrustAnchor.
getTrustAnchor in interface AWSIAMRolesAnywheregetTrustAnchorRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public ImportCrlResult importCrl(ImportCrlRequest request)
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.
importCrl in interface AWSIAMRolesAnywhereimportCrlRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public ListCrlsResult listCrls(ListCrlsRequest request)
Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListCrls.
listCrls in interface AWSIAMRolesAnywherelistCrlsRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public ListProfilesResult listProfiles(ListProfilesRequest request)
Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListProfiles.
listProfiles in interface AWSIAMRolesAnywherelistProfilesRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public ListSubjectsResult listSubjects(ListSubjectsRequest request)
Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListSubjects.
listSubjects in interface AWSIAMRolesAnywherelistSubjectsRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags attached to the resource.
Required permissions: rolesanywhere:ListTagsForResource.
listTagsForResource in interface AWSIAMRolesAnywherelistTagsForResourceRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public ListTrustAnchorsResult listTrustAnchors(ListTrustAnchorsRequest request)
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListTrustAnchors.
listTrustAnchors in interface AWSIAMRolesAnywherelistTrustAnchorsRequest - ValidationException - Validation exception error.AccessDeniedException - You do not have sufficient access to perform this action.public PutAttributeMappingResult putAttributeMapping(PutAttributeMappingRequest request)
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.
putAttributeMapping in interface AWSIAMRolesAnywhereputAttributeMappingRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public PutNotificationSettingsResult putNotificationSettings(PutNotificationSettingsRequest request)
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.
putNotificationSettings in interface AWSIAMRolesAnywhereputNotificationSettingsRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public ResetNotificationSettingsResult resetNotificationSettings(ResetNotificationSettingsRequest request)
Resets the custom notification setting to IAM Roles Anywhere default setting.
Required permissions: rolesanywhere:ResetNotificationSettings.
resetNotificationSettings in interface AWSIAMRolesAnywhereresetNotificationSettingsRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public TagResourceResult tagResource(TagResourceRequest request)
Attaches tags to a resource.
Required permissions: rolesanywhere:TagResource.
tagResource in interface AWSIAMRolesAnywheretagResourceRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.TooManyTagsException - Too many tags.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from the resource.
Required permissions: rolesanywhere:UntagResource.
untagResource in interface AWSIAMRolesAnywhereuntagResourceRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public UpdateCrlResult updateCrl(UpdateCrlRequest request)
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.
updateCrl in interface AWSIAMRolesAnywhereupdateCrlRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public UpdateProfileResult updateProfile(UpdateProfileRequest request)
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.
updateProfile in interface AWSIAMRolesAnywhereupdateProfileRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public UpdateTrustAnchorResult updateTrustAnchor(UpdateTrustAnchorRequest request)
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.
updateTrustAnchor in interface AWSIAMRolesAnywhereupdateTrustAnchorRequest - ValidationException - Validation exception error.ResourceNotFoundException - The resource could not be found.AccessDeniedException - You do not have sufficient access to perform this action.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSIAMRolesAnywhererequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSIAMRolesAnywhereshutdown in class AmazonWebServiceClient