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 |
Returns information about all activities registered in the specified
domain that match the specified name and registration status. The result
includes information like creation date, current status of the activity,
etc. The results may be split into multiple pages. To retrieve
subsequent pages, make the call again using the nextPageToken
returned
by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
- Use a
Resource
element with the domain name to limit the action to only specified domains. - Use an
Action
element to allow or deny permission to call this action. - You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action,
or the parameter values fall outside the specified constraints, the
action fails. The associated event attribute's cause
parameter is set
to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows
in the Amazon SWF Developer Guide.
This operation returns paginated results.
Synopsis
- data ListActivityTypes = ListActivityTypes' {}
- newListActivityTypes :: Text -> RegistrationStatus -> ListActivityTypes
- listActivityTypes_nextPageToken :: Lens' ListActivityTypes (Maybe Text)
- listActivityTypes_reverseOrder :: Lens' ListActivityTypes (Maybe Bool)
- listActivityTypes_name :: Lens' ListActivityTypes (Maybe Text)
- listActivityTypes_maximumPageSize :: Lens' ListActivityTypes (Maybe Natural)
- listActivityTypes_domain :: Lens' ListActivityTypes Text
- listActivityTypes_registrationStatus :: Lens' ListActivityTypes RegistrationStatus
- data ListActivityTypesResponse = ListActivityTypesResponse' {
- nextPageToken :: Maybe Text
- httpStatus :: Int
- typeInfos :: [ActivityTypeInfo]
- newListActivityTypesResponse :: Int -> ListActivityTypesResponse
- listActivityTypesResponse_nextPageToken :: Lens' ListActivityTypesResponse (Maybe Text)
- listActivityTypesResponse_httpStatus :: Lens' ListActivityTypesResponse Int
- listActivityTypesResponse_typeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo]
Creating a Request
data ListActivityTypes Source #
See: newListActivityTypes
smart constructor.
ListActivityTypes' | |
|
Instances
Create a value of ListActivityTypes
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:nextPageToken:ListActivityTypes'
, listActivityTypes_nextPageToken
- If NextPageToken
is returned there are more results available. The
value of NextPageToken
is a unique pagination token for each page.
Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after
60 seconds. Using an expired pagination token will return a 400
error:
"Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be
returned in a single call.
$sel:reverseOrder:ListActivityTypes'
, listActivityTypes_reverseOrder
- When set to true
, returns the results in reverse order. By default,
the results are returned in ascending alphabetical order by name
of
the activity types.
$sel:name:ListActivityTypes'
, listActivityTypes_name
- If specified, only lists the activity types that have this name.
$sel:maximumPageSize:ListActivityTypes'
, listActivityTypes_maximumPageSize
- The maximum number of results that are returned per call. Use
nextPageToken
to obtain further pages of results.
$sel:domain:ListActivityTypes'
, listActivityTypes_domain
- The name of the domain in which the activity types have been registered.
$sel:registrationStatus:ListActivityTypes'
, listActivityTypes_registrationStatus
- Specifies the registration status of the activity types to list.
Request Lenses
listActivityTypes_nextPageToken :: Lens' ListActivityTypes (Maybe Text) Source #
If NextPageToken
is returned there are more results available. The
value of NextPageToken
is a unique pagination token for each page.
Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after
60 seconds. Using an expired pagination token will return a 400
error:
"Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be
returned in a single call.
listActivityTypes_reverseOrder :: Lens' ListActivityTypes (Maybe Bool) Source #
When set to true
, returns the results in reverse order. By default,
the results are returned in ascending alphabetical order by name
of
the activity types.
listActivityTypes_name :: Lens' ListActivityTypes (Maybe Text) Source #
If specified, only lists the activity types that have this name.
listActivityTypes_maximumPageSize :: Lens' ListActivityTypes (Maybe Natural) Source #
The maximum number of results that are returned per call. Use
nextPageToken
to obtain further pages of results.
listActivityTypes_domain :: Lens' ListActivityTypes Text Source #
The name of the domain in which the activity types have been registered.
listActivityTypes_registrationStatus :: Lens' ListActivityTypes RegistrationStatus Source #
Specifies the registration status of the activity types to list.
Destructuring the Response
data ListActivityTypesResponse Source #
Contains a paginated list of activity type information structures.
See: newListActivityTypesResponse
smart constructor.
ListActivityTypesResponse' | |
|
Instances
newListActivityTypesResponse Source #
Create a value of ListActivityTypesResponse
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:nextPageToken:ListActivityTypes'
, listActivityTypesResponse_nextPageToken
- If a NextPageToken
was returned by a previous call, there are more
results available. To retrieve the next page of results, make the call
again using the returned token in nextPageToken
. Keep all other
arguments unchanged.
The configured maximumPageSize
determines how many results can be
returned in a single call.
$sel:httpStatus:ListActivityTypesResponse'
, listActivityTypesResponse_httpStatus
- The response's http status code.
$sel:typeInfos:ListActivityTypesResponse'
, listActivityTypesResponse_typeInfos
- List of activity type information.
Response Lenses
listActivityTypesResponse_nextPageToken :: Lens' ListActivityTypesResponse (Maybe Text) Source #
If a NextPageToken
was returned by a previous call, there are more
results available. To retrieve the next page of results, make the call
again using the returned token in nextPageToken
. Keep all other
arguments unchanged.
The configured maximumPageSize
determines how many results can be
returned in a single call.
listActivityTypesResponse_httpStatus :: Lens' ListActivityTypesResponse Int Source #
The response's http status code.
listActivityTypesResponse_typeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo] Source #
List of activity type information.