VPCLattice / Client / get_auth_policy

get_auth_policy¶

VPCLattice.Client.get_auth_policy(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.get_auth_policy(
    resourceIdentifier='string'
)

Parameters:

resourceIdentifier (string) –

[REQUIRED]

The ID or ARN of the service network or service.

Return type:

dict

Returns:

Response Syntax

{
    'policy': 'string',
    'state': 'Active'|'Inactive',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- policy (string) –
  
  The auth policy.
- state (string) –
  
  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.
- createdAt (datetime) –
  
  The date and time that the auth policy was created, in ISO-8601 format.
- lastUpdatedAt (datetime) –
  
  The date and time that the auth policy was last updated, in ISO-8601 format.

Exceptions

VPCLattice.Client.exceptions.ValidationException
VPCLattice.Client.exceptions.AccessDeniedException
VPCLattice.Client.exceptions.ResourceNotFoundException
VPCLattice.Client.exceptions.ThrottlingException
VPCLattice.Client.exceptions.InternalServerException