PolicySummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.organizations.model.PolicySummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PolicySummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PolicySummary()

Constructors
Constructor and Description
`PolicySummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PolicySummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the policy.
`Boolean`	`getAwsManaged()` A boolean value that indicates whether the specified policy is an AWS managed policy.
`String`	`getDescription()` The description of the policy.
`String`	`getId()` The unique identifier (ID) of the policy.
`String`	`getName()` The friendly name of the policy.
`String`	`getType()` The type of policy.
`int`	`hashCode()`
`Boolean`	`isAwsManaged()` A boolean value that indicates whether the specified policy is an AWS managed policy.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the policy.
`void`	`setAwsManaged(Boolean awsManaged)` A boolean value that indicates whether the specified policy is an AWS managed policy.
`void`	`setDescription(String description)` The description of the policy.
`void`	`setId(String id)` The unique identifier (ID) of the policy.
`void`	`setName(String name)` The friendly name of the policy.
`void`	`setType(PolicyType type)` The type of policy.
`void`	`setType(String type)` The type of policy.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PolicySummary`	`withArn(String arn)` The Amazon Resource Name (ARN) of the policy.
`PolicySummary`	`withAwsManaged(Boolean awsManaged)` A boolean value that indicates whether the specified policy is an AWS managed policy.
`PolicySummary`	`withDescription(String description)` The description of the policy.
`PolicySummary`	`withId(String id)` The unique identifier (ID) of the policy.
`PolicySummary`	`withName(String name)` The friendly name of the policy.
`PolicySummary`	`withType(PolicyType type)` The type of policy.
`PolicySummary`	`withType(String type)` The type of policy.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PolicySummary
```
public PolicySummary()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The unique identifier (ID) of the policy.
    
    The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
    
    Parameters:
    
    id - The unique identifier (ID) of the policy.
    
    The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
  - getId
```
public String getId()
```
    The unique identifier (ID) of the policy.
    
    The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
    
    Returns:
    
    The unique identifier (ID) of the policy.
    
    The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
  - withId
```
public PolicySummary withId(String id)
```
    The unique identifier (ID) of the policy.
    
    The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
    
    Parameters:
    
    id - The unique identifier (ID) of the policy.
    
    The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the policy.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the policy.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the policy.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the policy.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - withArn
```
public PolicySummary withArn(String arn)
```
    The Amazon Resource Name (ARN) of the policy.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the policy.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The friendly name of the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
    
    Parameters:
    
    name - The friendly name of the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
  - getName
```
public String getName()
```
    The friendly name of the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
    
    Returns:
    
    The friendly name of the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
  - withName
```
public PolicySummary withName(String name)
```
    The friendly name of the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
    
    Parameters:
    
    name - The friendly name of the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the policy.
    
    Parameters:
    
    description - The description of the policy.
  - getDescription
```
public String getDescription()
```
    The description of the policy.
    
    Returns:
    
    The description of the policy.
  - withDescription
```
public PolicySummary withDescription(String description)
```
    The description of the policy.
    
    Parameters:
    
    description - The description of the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    See Also:
    
    PolicyType
  - getType
```
public String getType()
```
    The type of policy.
    
    Returns:
    
    The type of policy.
    
    See Also:
    
    PolicyType
  - withType
```
public PolicySummary withType(String type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PolicyType
  - setType
```
public void setType(PolicyType type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    See Also:
    
    PolicyType
  - withType
```
public PolicySummary withType(PolicyType type)
```
    The type of policy.
    
    Parameters:
    
    type - The type of policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PolicyType
  - setAwsManaged
```
public void setAwsManaged(Boolean awsManaged)
```
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    
    Parameters:
    
    awsManaged - A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
  - getAwsManaged
```
public Boolean getAwsManaged()
```
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    
    Returns:
    
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
  - withAwsManaged
```
public PolicySummary withAwsManaged(Boolean awsManaged)
```
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    
    Parameters:
    
    awsManaged - A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAwsManaged
```
public Boolean isAwsManaged()
```
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    
    Returns:
    
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PolicySummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PolicySummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolicySummary

Method Detail

setId

getId

withId

setArn

getArn

withArn

setName

getName

withName

setDescription

getDescription

withDescription

setType

getType

withType

setType

withType

setAwsManaged

getAwsManaged

withAwsManaged

isAwsManaged

toString

equals

hashCode

clone

marshall