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

GetAuthPolicy

Retrieves information about the auth policy for the specified service or service network.

Request Syntax


GET /authpolicy/resourceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceIdentifier

The ID or Amazon Resource Name (ARN) of the service network or service.

Length Constraints: Minimum length of 17. Maximum length of 200.

Pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "lastUpdatedAt": "string",
   "policy": "string",
   "state": "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.

createdAt

The date and time that the auth policy was created, specified in ISO-8601 format.

Type: Timestamp

lastUpdatedAt

The date and time that the auth policy was last updated, specified in ISO-8601 format.

Type: Timestamp

policy

The auth policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10000.

state

The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is NONE, then any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

Type: String

Valid Values: Active | Inactive

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400