AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to GetRoleAsync.

Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

C#
public abstract GetRoleResponse GetRole(
         GetRoleRequest request
)
Parameters
request
Type: Amazon.IdentityManagement.Model.GetRoleRequest

Container for the necessary parameters to execute the GetRole service method.

Return Value
The response from the GetRole service method, as returned by IdentityManagementService.

Exceptions

ExceptionCondition
NoSuchEntityException The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
ServiceFailureException The request processing has failed because of an unknown error, exception or failure.

Examples

The following command gets information about the role named Test-Role.

To get information about an IAM role


var response = client.GetRole(new GetRoleRequest 
{
    RoleName = "Test-Role"
});

Role role = response.Role;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also