TestRoleRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.elastictranscoder.model.TestRoleRequest

All Implemented Interfaces:

Serializable
```
public class TestRoleRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the TestRole operation.
The TestRole operation tests the IAM role used to create the pipeline.

The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

See Also:
AmazonElasticTranscoder.testRole(TestRoleRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

TestRoleRequest()

Constructors
Constructor and Description
`TestRoleRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getInputBucket()` The Amazon S3 bucket that contains media files to be transcoded.
`String`	`getOutputBucket()` The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to.
`String`	`getRole()` The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
`List<String>`	`getTopics()` The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
`int`	`hashCode()`
`void`	`setInputBucket(String inputBucket)` The Amazon S3 bucket that contains media files to be transcoded.
`void`	`setOutputBucket(String outputBucket)` The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to.
`void`	`setRole(String role)` The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
`void`	`setTopics(Collection<String> topics)` The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TestRoleRequest`	`withInputBucket(String inputBucket)` The Amazon S3 bucket that contains media files to be transcoded.
`TestRoleRequest`	`withOutputBucket(String outputBucket)` The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to.
`TestRoleRequest`	`withRole(String role)` The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
`TestRoleRequest`	`withTopics(Collection<String> topics)` The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
`TestRoleRequest`	`withTopics(String... topics)` The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

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

- Constructor Detail
  - TestRoleRequest
```
public TestRoleRequest()
```
- Method Detail
  - getRole
```
public String getRole()
```
    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
    Constraints:
    Pattern: ^arn:aws:iam::\w{12}:role/.+$
    
    Returns:
    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
  - setRole
```
public void setRole(String role)
```
    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
    Constraints:
    Pattern: ^arn:aws:iam::\w{12}:role/.+$
    
    Parameters:
    role - The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
  - withRole
```
public TestRoleRequest withRole(String role)
```
    The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^arn:aws:iam::\w{12}:role/.+$
    
    Parameters:
    role - The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getInputBucket
```
public String getInputBucket()
```
    The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
    Constraints:
    Pattern: ^(\w|\.|-){1,255}$
    
    Returns:
    The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
  - setInputBucket
```
public void setInputBucket(String inputBucket)
```
    The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
    Constraints:
    Pattern: ^(\w|\.|-){1,255}$
    
    Parameters:
    inputBucket - The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
  - withInputBucket
```
public TestRoleRequest withInputBucket(String inputBucket)
```
    The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^(\w|\.|-){1,255}$
    
    Parameters:
    inputBucket - The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOutputBucket
```
public String getOutputBucket()
```
    The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
    Constraints:
    Pattern: ^(\w|\.|-){1,255}$
    
    Returns:
    The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
  - setOutputBucket
```
public void setOutputBucket(String outputBucket)
```
    The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
    Constraints:
    Pattern: ^(\w|\.|-){1,255}$
    
    Parameters:
    outputBucket - The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
  - withOutputBucket
```
public TestRoleRequest withOutputBucket(String outputBucket)
```
    The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^(\w|\.|-){1,255}$
    
    Parameters:
    outputBucket - The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTopics
```
public List<String> getTopics()
```
    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
    Constraints:
    Length: 0 - 30
    
    Returns:
    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
  - setTopics
```
public void setTopics(Collection<String> topics)
```
    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    topics - The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
  - withTopics
```
public TestRoleRequest withTopics(String... topics)
```
    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    topics - The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTopics
```
public TestRoleRequest withTopics(Collection<String> topics)
```
    The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    topics - The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class TestRoleRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

TestRoleRequest

Method Detail

getRole

setRole

withRole

getInputBucket

setInputBucket

withInputBucket

getOutputBucket

setOutputBucket

withOutputBucket

getTopics

setTopics

withTopics

withTopics

toString

hashCode

equals