# DescribePredefinedAttribute
<a name="API_DescribePredefinedAttribute"></a>

Describes a predefined attribute for the specified Amazon Connect instance. A *predefined attribute* is made up of a name and a value. You can use predefined attributes for:
+ Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see [Create predefined attributes for routing contacts to agents](https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html).
+ Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see [Use contact segment attributes](https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html).

For the predefined attributes per instance quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas).

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_DescribePredefinedAttribute_RequestSyntax"></a>

```
GET /predefined-attributes/InstanceId/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePredefinedAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribePredefinedAttribute_RequestSyntax) **   <a name="connect-DescribePredefinedAttribute-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_DescribePredefinedAttribute_RequestSyntax) **   <a name="connect-DescribePredefinedAttribute-request-uri-Name"></a>
The name of the predefined attribute.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribePredefinedAttribute_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePredefinedAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PredefinedAttribute": { 
      "AttributeConfiguration": { 
         "EnableValueValidationOnAssociation": boolean,
         "IsReadOnly": boolean
      },
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Purposes": [ "string" ],
      "Values": { ... }
   }
}
```

## Response Elements
<a name="API_DescribePredefinedAttribute_ResponseElements"></a>

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

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

 ** [PredefinedAttribute](#API_DescribePredefinedAttribute_ResponseSyntax) **   <a name="connect-DescribePredefinedAttribute-response-PredefinedAttribute"></a>
Information about the predefined attribute.  
Type: [PredefinedAttribute](API_PredefinedAttribute.md) object

## Errors
<a name="API_DescribePredefinedAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DescribePredefinedAttribute_Examples"></a>

### Example
<a name="API_DescribePredefinedAttribute_Example_1"></a>

The following example shows a request and response.

```
GET https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId/Name HTTP/1.1

Response:
{
    "PredefinedAttribute": {
        "AttributeConfiguration": {
            "EnableValueValidationOnAssociation": false,
            "IsReadOnly": false
        },
        "LastModifiedRegion": "us-west-2",
        "LastModifiedTime": 1.756932542054E9,
        "Name": "Custom",
        "Purposes": [
            "proficiency"
        ],
        "Values": {
            "StringList": [
                "value1",
                "value2"
            ]
        }
    }
}
```

## See Also
<a name="API_DescribePredefinedAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribePredefinedAttribute)