Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListEntities

Returns the available entities supported by the connection type.

Request Syntax


{
   "CatalogId": "string",
   "ConnectionName": "string",
   "DataStoreApiVersion": "string",
   "NextToken": "string",
   "ParentEntityName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

The catalog ID of the catalog that contains the connection. This can be null, By default, the AWS Account ID is the catalog ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

ConnectionName

A name for the connection that has required credentials to query any connection type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

DataStoreApiVersion

The API version of the SaaS connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9.-]*

Required: No

NextToken

A continuation token, included if this is a continuation call.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [-a-zA-Z0-9+=/:_]*

Required: No

ParentEntityName

Name of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.

Type: String

Required: No

Response Syntax


{
   "Entities": [ 
      { 
         "Category": "string",
         "CustomProperties": { 
            "string" : "string" 
         },
         "Description": "string",
         "EntityName": "string",
         "IsParentEntity": boolean,
         "Label": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entities

A list of Entity objects.

Type: Array of Entity objects

NextToken

A continuation token, present if the current segment is not the last.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [-a-zA-Z0-9+=/:_]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

Message: A message describing the problem.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

FederationSourceException

A federation source failed.

FederationSourceErrorCode: The error code of the problem.
Message: The message describing the problem.

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

Message: The message describing the problem.

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400

ValidationException

A value could not be validated.

Message: A message describing the problem.

HTTP Status Code: 400