| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SageMaker.DescribeWorkforce
Description
Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.
This operation applies only to private workforces.
Synopsis
- data DescribeWorkforce = DescribeWorkforce' {}
- newDescribeWorkforce :: Text -> DescribeWorkforce
- describeWorkforce_workforceName :: Lens' DescribeWorkforce Text
- data DescribeWorkforceResponse = DescribeWorkforceResponse' {
- httpStatus :: Int
- workforce :: Workforce
- newDescribeWorkforceResponse :: Int -> Workforce -> DescribeWorkforceResponse
- describeWorkforceResponse_httpStatus :: Lens' DescribeWorkforceResponse Int
- describeWorkforceResponse_workforce :: Lens' DescribeWorkforceResponse Workforce
Creating a Request
data DescribeWorkforce Source #
See: newDescribeWorkforce smart constructor.
Constructors
| DescribeWorkforce' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribeWorkforce |
Create a value of DescribeWorkforce with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workforceName:DescribeWorkforce', describeWorkforce_workforceName - The name of the private workforce whose access you want to restrict.
WorkforceName is automatically set to default when a workforce is
created and cannot be modified.
Request Lenses
describeWorkforce_workforceName :: Lens' DescribeWorkforce Text Source #
The name of the private workforce whose access you want to restrict.
WorkforceName is automatically set to default when a workforce is
created and cannot be modified.
Destructuring the Response
data DescribeWorkforceResponse Source #
See: newDescribeWorkforceResponse smart constructor.
Constructors
| DescribeWorkforceResponse' | |
Fields
| |
Instances
newDescribeWorkforceResponse Source #
Arguments
| :: Int | |
| -> Workforce | |
| -> DescribeWorkforceResponse |
Create a value of DescribeWorkforceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeWorkforceResponse', describeWorkforceResponse_httpStatus - The response's http status code.
$sel:workforce:DescribeWorkforceResponse', describeWorkforceResponse_workforce - A single private workforce, which is automatically created when you
create your first private work team. You can create one private work
force in each Amazon Web Services Region. By default, any
workforce-related API operation used in a specific region will apply to
the workforce created in that region. To learn how to create a private
workforce, see
Create a Private Workforce.
Response Lenses
describeWorkforceResponse_httpStatus :: Lens' DescribeWorkforceResponse Int Source #
The response's http status code.
describeWorkforceResponse_workforce :: Lens' DescribeWorkforceResponse Workforce Source #
A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.