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.

Try to get Amazon.Runtime.AWSCredentials from a profile.

If ProfilesLocation is non-null and non-empty search the shared credentials file at the disk path in the ProfilesLocation property.

If ProfilesLocation is null or empty and the platform supports the .NET SDK credentials file search the SDK credentials file. If the profile is not found search the shared credentials file in the default location.

If ProfilesLocation is null or empty and the platform doesn't support the .NET SDK credentials file search the shared credentials file in the default location.

Namespace: Amazon.Runtime.CredentialManagement
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C#
public Boolean TryGetAWSCredentials(
         String profileName,
         AWSCredentials credentials
)

Parameters

profileName
Type: System.String

The name of the profile to get credentials from.

credentials
Type: Amazon.Runtime.AWSCredentials

The credentials, if the profile is found and credentials can be created.

Return Value


Type: Boolean
True if the profile was found and credentials could be created, false otherwise.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5