Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSubscriber

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

Request Syntax


GET /v1/subscribers/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "subscriber": { 
      "accessTypes": [ "string" ],
      "accountId": "string",
      "createdAt": number,
      "externalId": "string",
      "roleArn": "string",
      "s3BucketArn": "string",
      "snsArn": "string",
      "sourceTypes": [ 
         { 
            "awsSourceType": "string",
            "customSourceType": "string"
         }
      ],
      "subscriberDescription": "string",
      "subscriberName": "string",
      "subscriptionEndpoint": "string",
      "subscriptionId": "string",
      "subscriptionProtocol": "string",
      "subscriptionStatus": "string",
      "updatedAt": number
   }
}

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.

subscriber

The subscription information for the specified subscription ID.

Type: SubscriberResource object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific AWS action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.

HTTP Status Code: 403

AccountNotFoundException

Amazon Security Lake cannot find an AWS account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

HTTP Status Code: 403

InternalServerException

Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.

HTTP Status Code: 500

InvalidInputException

The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404