Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDataCatalog

Returns the specified data catalog.

Request Syntax


{
   "Name": "string",
   "WorkGroup": "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.

Name

The name of the data catalog to return.

Type: String

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

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

Required: Yes

WorkGroup

The name of the workgroup. Required if making an IAM Identity Center request.

Type: String

Pattern: [a-zA-Z0-9._-]{1,128}

Required: No

Response Syntax


{
   "DataCatalog": { 
      "Description": "string",
      "Name": "string",
      "Parameters": { 
         "string" : "string" 
      },
      "Type": "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.

DataCatalog

The data catalog returned.

Type: DataCatalog object

Errors

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

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400