JSDoc: Class: AWSCredentials

new AWSCredentials()

Source:

AWSCredentials.js, line 7

Methods

AWSCredentialsProvider(AWSCognitoIdentity)

AWSCredentialsProvider call to get temporary AccessKeyId, SecretKey, and SessionToken from AWSCognitoIdentity returns: {AWSCognitoCredentials >}

Parameters:

Name	Type	Description
`AWSCognitoIdentity`

Source:

AWSCredentials.js, line 175

AWSIdentityProvider(authoritativeProperty)

AWSIdentityProvider call to get temporary Cognito IdentityId and Token returns: {AWSCognitoIdentity }

Parameters:

Name	Type	Description
`authoritativeProperty`

Source:

AWSCredentials.js, line 153

GetAuthorization(authoritativeProperty)

Function returns a AWSCognitoIdentity and AWSCognitoCredentials object Both are needed to assume AWS.Credentials returns: {AWSCognitoIdentity, AWSCognitoCredentials}

Parameters:

Name	Type	Description
`authoritativeProperty`

Source:

AWSCredentials.js, line 134

healthRequest() → {HTTPResponse}

Does a health check on AWSCognito via GET /ping HTTP/1.1

Source:

AWSCredentials.js, line 65

Returns:

Type: HTTPResponse

listIdentities(results, token) → {array}

ListIdentities call to list Identities in Identity Pool

Parameters:

Name	Type	Default	Description
`results`		10	amount of Identities to list
`token`		null	`NextToken` to continue listing identities

Source:

AWSCredentials.js, line 108

Returns:

Type: array

(non-null) new AWSCredentials(options)

options required for communication with AWS Cognito











    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                options
            

            
            
            

            

            

            
        

    
    







    Properties:

    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                region
            

            
            
                
string


            
            

            

            

            AWS Region of operation
        

    

        
            
                IdentityPoolId
            

            
            
                
string


            
            

            

            

            "{region}:{IdentityPoolId UUID}"
        

    

        
            
                DeveloperName
            

            
            
                
string


            
            

            

            

            "com.developer.name" for Developer provider name
        

    

        
            
                TokenDuration
            

            
            
                
number


            
            

            

            

            Amount of time the session token should last
        

    
    







    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        AWSCredentials.js, line 21

Name	Type	Description
`options`

Name	Type	Description
`region`	string	AWS Region of operation
`IdentityPoolId`	string	"{region}:{IdentityPoolId UUID}"
`DeveloperName`	string	"com.developer.name" for Developer provider name
`TokenDuration`	number	Amount of time the session token should last



    

    

    

     

    

    

    
        Methods

        
            

    

    AWSCredentialsProvider(AWSCognitoIdentity)

    




    AWSCredentialsProvider call to get temporary AccessKeyId, SecretKey, and SessionToken from AWSCognitoIdentity
returns: {AWSCognitoCredentials >}










    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                AWSCognitoIdentity
            

            
            
            

            

            

            
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        AWSCredentials.js, line 175
    
    

    

    

    

















        
            

    

    AWSIdentityProvider(authoritativeProperty)

    




    AWSIdentityProvider call to get temporary Cognito IdentityId and Token
returns: {AWSCognitoIdentity }










    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                authoritativeProperty
            

            
            
            

            

            

            
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        AWSCredentials.js, line 153
    
    

    

    

    

















        
            

    

    GetAuthorization(authoritativeProperty)

    




    Function returns a AWSCognitoIdentity and AWSCognitoCredentials object
      Both are needed to assume AWS.Credentials
returns: {AWSCognitoIdentity, AWSCognitoCredentials}










    Parameters:
    


    
    
        
        Name
        

        Type

        

        

        Description
    
    

    
    

        
            
                authoritativeProperty
            

            
            
            

            

            

            
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        AWSCredentials.js, line 134
    
    

    

    

    

















        
            

    

    healthRequest() → {HTTPResponse}

    




    Does a health check on AWSCognito via GET /ping HTTP/1.1
















    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        AWSCredentials.js, line 65
    
    

    

    

    














Returns:

        



    
        Type
    
    
        
HTTPResponse


    


    



        
            

    

    listIdentities(results, token) → {array}

    




    ListIdentities call to list Identities in Identity Pool










    Parameters:
    


    
    
        
        Name
        

        Type

        

        
        Default
        

        Description
    
    

    
    

        
            
                results
            

            
            
            

            

            
                
                
                    10
                
                
            

            amount of Identities to list
        

    

        
            
                token
            

            
            
            

            

            
                
                
                    null
                
                
            

            NextToken to continue listing identities
        

    
    









    

    

    

    

    

    

    

    

    

    

    

    

    
    Source:
    
        AWSCredentials.js, line 108
    
    

    

    

    














Returns:

        



    
        Type
    
    
        
array