# DescribeOptOutLists
<a name="API_DescribeOptOutLists"></a>

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an error is returned.

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

```
{
   "MaxResults": number,
   "NextToken": "string",
   "OptOutListNames": [ "string" ],
   "Owner": "string"
}
```

## Request Parameters
<a name="API_DescribeOptOutLists_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_DescribeOptOutLists_RequestSyntax) **   <a name="pinpoint-DescribeOptOutLists-request-MaxResults"></a>
The maximum number of results to return per each request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_DescribeOptOutLists_RequestSyntax) **   <a name="pinpoint-DescribeOptOutLists-request-NextToken"></a>
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.+`   
Required: No

 ** [OptOutListNames](#API_DescribeOptOutLists_RequestSyntax) **   <a name="pinpoint-DescribeOptOutLists-request-OptOutListNames"></a>
The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.  
If you are using a shared AWS End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[A-Za-z0-9_:/-]+`   
Required: No

 ** [Owner](#API_DescribeOptOutLists_RequestSyntax) **   <a name="pinpoint-DescribeOptOutLists-request-Owner"></a>
Use `SELF` to filter the list of Opt-Out List to ones your account owns or use `SHARED` to filter on Opt-Out List shared with your account. The `Owner` and `OptOutListNames` parameters can't be used at the same time.  
Type: String  
Valid Values: `SELF | SHARED`   
Required: No

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

```
{
   "NextToken": "string",
   "OptOutLists": [ 
      { 
         "CreatedTimestamp": number,
         "OptOutListArn": "string",
         "OptOutListName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeOptOutLists_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.

 ** [NextToken](#API_DescribeOptOutLists_ResponseSyntax) **   <a name="pinpoint-DescribeOptOutLists-response-NextToken"></a>
The token to be used for the next set of paginated results. If this field is empty then there are no more results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.+` 

 ** [OptOutLists](#API_DescribeOptOutLists_ResponseSyntax) **   <a name="pinpoint-DescribeOptOutLists-response-OptOutLists"></a>
An array of OptOutListInformation objects that contain the details for the requested OptOutLists.  
Type: Array of [OptOutListInformation](API_OptOutListInformation.md) objects

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

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

 ** AccessDeniedException **   
The request was denied because you don't have sufficient permissions to access the resource.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 400

 ** InternalServerException **   
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.    
 ** RequestId **   
The unique identifier of the request.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A requested resource couldn't be found.    
 ** ResourceId **   
The unique identifier of the resource.  
 ** ResourceType **   
The type of resource that caused the exception.
HTTP Status Code: 400

 ** ThrottlingException **   
An error that occurred because too many requests were sent during a certain amount of time.  
HTTP Status Code: 400

 ** ValidationException **   
A validation exception for a field.    
 ** Fields **   
The field that failed validation.  
 ** Reason **   
The reason for the exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeOptOutLists_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/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutLists)